CDPGuidesSupport

Session Replays

List recorded session replay summaries and retrieve daily replay totals through the REST API.

List replay-bearing sessions for an inclusive calendar-day range. The list supports event, page, visitor, UTM, and explicit session-ID filters, and uses cursor pagination. The overview endpoint returns account-wide replay totals and a daily timeseries for the same date range.

GET
/rest/v1/session-replays

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Query Parameters

from*string

Inclusive lower bound of the replay window as YYYY-MM-DD.

Match^\d{4}-\d{2}-\d{2}$
Formatdate
to*string

Inclusive upper bound of the replay window as YYYY-MM-DD.

Match^\d{4}-\d{2}-\d{2}$
Formatdate
eventName?string
Length1 <= length <= 500
pathname?string
Length1 <= length <= 500
visitorId?string
Length1 <= length <= 200
utmSource?string
Length1 <= length <= 512
utmMedium?string
Length1 <= length <= 512
utmCampaign?string
Length1 <= length <= 512
utmContent?string
Length1 <= length <= 512
utmTerm?string
Length1 <= length <= 512
utmName?string
Length1 <= length <= 512
sessionIds?string

Optional JSON-encoded session ID array. Maximum 100 session IDs.

limit?integer

Maximum replay sessions to return. Defaults to the report default.

Range1 <= value <= 100
cursor?string

Opaque pagination cursor from pagination.nextCursor in the previous response. Do not decode or modify it. Malformed cursors return 400 Bad Request.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rest/v1/session-replays?from=2019-08-24&to=2019-08-24"
{  "items": [    {      "sessionId": "string",      "visitorId": "string",      "date": "string",      "duration": 0,      "eventCount": 0,      "pageCount": 0,      "startTime": "string"    }  ],  "pagination": {    "nextCursor": "string",    "hasMore": true  }}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
GET
/rest/v1/session-replays/overview

Authorization

apiKey
AuthorizationBearer <token>

Ours Privacy API key

In: header

Query Parameters

from*string

Inclusive lower bound of the replay window as YYYY-MM-DD.

Match^\d{4}-\d{2}-\d{2}$
Formatdate
to*string

Inclusive upper bound of the replay window as YYYY-MM-DD.

Match^\d{4}-\d{2}-\d{2}$
Formatdate

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rest/v1/session-replays/overview?from=2019-08-24&to=2019-08-24"
{  "totalReplays": 0,  "timeseries": [    {      "date": "string",      "value": 0    }  ]}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}
{  "error": "string",  "details": "string"}

How is this guide?

Web Analytics

Previous Page

Translation Widget Analytics

Next Page