Analytics

Get detailed information about a specific session including events and request logs

get/analytics/sessions/{session_id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/analytics/sessions/{session_id}
  • Auth: HTTP bearer

Path parameters

session_idinteger required

Session ID

Query parameters

project_idinteger required

Project ID or slug

environment_idinteger

Environment ID (optional)

Response

Successfully retrieved session details

duration_secondsinteger required
ended_atstring date-time nullable
entry_pathstring nullable
exit_pathstring nullable
is_bouncedboolean required
is_engagedboolean required
page_viewsinteger required
referrerstring nullable
session_idinteger required
started_atstring date-time required
visitor_idstring required

Example response

{
  "ended_at": "2024-01-01T00:00:00",
  "started_at": "2024-01-01T00:00:00"
}

Changes

No recorded changes to this operation across all 53 revisions of this API.