Session replays

Get a session replay recording

GET/api/websites/{websiteId}/replays/{replayId}

Returns the merged recording events, session details, and event and chunk counts for a replay, with optional stopping points by timestamp, chunk, or event index.

Try it

Headers

Name	Type	Description
Authorizationrequired	string	Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only). `Bearer <token>`.
x-umami-share-contextrequired	string	Required context header when authenticating with a share token. `<api-key>`.
x-umami-share-tokenrequired	string	Signed token returned by a share endpoint. `<api-key>`.

Path parameters

Name	Type	Description
websiteIdrequired	string	ID of the website.
replayIdrequired	string	ID of the session replay.

Responses

200The operation completed successfully.

Name	Type	Description
chunkCountrequired	number	Number of stored recording chunks.
endedAtrequired	string	Date and time the recording ended.
eventCountrequired	number	Number of recorded replay events.
eventsrequired	any[]
sessionIdrequired	string	ID of the visitor session.
startedAtrequired	string	Date and time the recording started.

200 example

{
  "chunkCount": 0,
  "endedAt": "2024-01-15T09:30:00Z",
  "eventCount": 0,
  "events": [
    {}
  ],
  "sessionId": "string",
  "startedAt": "2024-01-15T09:30:00Z"
}

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}/replays/{replayId}' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-umami-share-context: <api-key>' \
  -H 'x-umami-share-token: <api-key>'

PreviousList website session replays NextList saved session replays