Sessions

List a visitor's session replays

GET/api/websites/{websiteId}/sessions/{sessionId}/replays

Returns a paginated, searchable list of recordings for the specified website session.

Headers

Name	Type	Description
Authorizationrequired	string	Authentication credentials, e.g. `Bearer <token>`.

Path parameters

Name	Type	Description
websiteIdrequired	string	ID of the website.
sessionIdrequired	string	ID of the visitor session.

Query parameters

Name	Type	Description
startAt	number	Start of the date range as a Unix timestamp in milliseconds.
endAt	number	End of the date range as a Unix timestamp in milliseconds.
startDate	string	Start of the date range as an ISO 8601 date or date-time.
endDate	string	End of the date range as an ISO 8601 date or date-time.
timezone	string	IANA time zone used to interpret dates and group results, for example America/New_York.
unit	string	Time interval used to group results: minute, hour, day, month, or year.
compare	enum<string>	Comparison period: prev for the previous period or yoy for the same period last year. Options: `prev`, `yoy`
page	integer	Page number, starting at 1.
pageSize	integer	Number of results per page.
maxResults	integer	Maximum number of results to include.
search	string	Search text used to filter results.

Responses

200The operation completed successfully.

Name	Type	Description
countrequired	number	Number of matching records.
datarequired	object[]	Data returned by the operation.

isCapped	boolean	Whether the results were truncated by the maximum result limit.
orderBy	string	Field to sort the results by.
pagerequired	number	Page number, starting at 1.
pageSizerequired	number	Number of results per page.
search	string	Search text used to filter results.
sortDescending	boolean	Whether to sort results in descending order.

200 example

{
  "count": 0,
  "data": [
    {
      "browser": "string",
      "chunkCount": 0,
      "city": "string",
      "country": "string",
      "createdAt": "string",
      "device": "string",
      "duration": 0,
      "endedAt": "string",
      "eventCount": 0,
      "id": "string",
      "os": "string",
      "sessionId": "string",
      "startedAt": "string",
      "websiteId": "string"
    }
  ],
  "isCapped": true,
  "orderBy": "string",
  "page": 0,
  "pageSize": 0,
  "search": "string",
  "sortDescending": true
}

400Bad request.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

400 example

{
  "error": {
    "code": "bad-request",
    "message": "Bad request.",
    "status": 400
  }
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

Code samples

cURL

curl -X GET 'https://api.example.com/api/websites/{websiteId}/sessions/{sessionId}/replays' \
  -H 'Authorization: Bearer <token>'

PreviousGet a session's custom properties NextCreate a share