Session Info

The Session Info endpoint provides information about a recording started with the SDK.

Returns information about a Report that has been previously requested via API.

GET https://widget-api.bugpilot.io/api/v1/session-info/<workspaceId>/<sessionToken>

This endpoint

Path Parameters

Name

Type

Description

workspaceId*

String

The id of the workspace you are fetching information from

sessionToken*

String

A session token, as returned from one of the Action endpoints

Headers

Name

Type

Description

String

Either text/html or application/json This changes the behavior of the endpoint in case of a successful response.

{"error":"INVALID_SESSION_TOKEN","error_message":"Invalid workspace or session token","ts":1669740566422}

{"error":"REPORT_NOT_FOUND","error_message":"The report identified by the session token was not found. Probably the report was deleted, not correctly saved from the client, or canceled by the user.","ts":1669740591980}

The success response includes a reportUrl property. ReportUrl is a string to a Bugpilot Report that you can access. It's the same URL you would see from the reports list in the dashboard.

IMPORTANT: If the HTTP Accept header includes text/html, then a successful response will redirect to the dashboard page for the report. You could, for example, open the session info URL directly in the browser, and you would be redirected to the report page.

{
  "ok":true,
  "reportUrl":"https://dash.bugpilot.io/report/r1-report-id",
  "ts": 1669740636649
}

PreviousUpdate Report NextGetting Started

Last updated 2 years ago

hashtagReturns information about a Report that has been previously requested via API.

hashtagPath Parameters

hashtagHeaders

Returns information about a Report that has been previously requested via API.

Path Parameters

Headers