---
title: "Get a session recording"
method: POST
path: "/replays/events"
tags: ["Replays"]
---

# Get a session recording

`POST /replays/events`

## Request

- Base URL: `https://api.databuddy.cc`
- URL: `https://api.databuddy.cc/replays/events`
- Auth: API key in header `x-api-key`

Returns a page of download URLs for one independently playable recording part and its session metadata. Select partId from parts, and pass nextCursor as cursor within that part. metadataOnly returns status without download URLs. Requires website read permission and replay enabled.

## Request body

- object
  - `cursor` string
  - `partId` string
  - `metadataOnly` boolean
  - `limit` integer
  - `sessionId` string, required
  - `websiteId` string, required

## Response `200`

OK

- object
  - `chunks` string[], required
  - `cutoffReason` string, nullable, required
  - `partId` string, nullable, required
  - `parts` object[], required
    - `endedAt` number, nullable, required
    - `expandedBytes` number, nullable, required
    - `id` string, required
    - `reason` string, nullable, required
    - `startedAt` number, nullable, required
  - `urlTtlSeconds` number, required
  - `customEvents` object[], required
    - `at` number, required
    - `name` string, required
  - `nextCursor` string, nullable, required
  - `session` object, required
    - `browser` string, nullable, required
    - `category` 'browsing' | 'evaluating' | 'signing_up' | 'using' | 'buying' | 'support' | 'other', nullable, required
    - `country` string, nullable, required
    - `deviceType` string, nullable, required
    - `displayName` string, nullable, required
    - `email` string, nullable, required
    - `endedAt` number, nullable, required
    - `entryPath` string, nullable, required
    - `exitPath` string, nullable, required
    - `os` string, nullable, required
    - `pageviews` number, required
    - `profileId` string, nullable, required
    - `rageClicks` number, required
    - `errors` number, required
    - `events` string[], required
    - `friction` object[], required
      - `clicks` number, required
      - `key` string, required
      - `kind` 'dead' | 'rage' | 'unresponsive', required
      - `label` string, required
      - `offsetMs` number, required
      - `path` string, nullable, required
    - `recordedMs` number, nullable, required
    - `referrer` string, nullable, required
    - `sessionId` string, required
    - `startedAt` number, nullable, required
    - `traits` object, required
    - `visitorId` string, nullable, required
    - `watchScore` number, nullable, required
  - `truncated` boolean, required

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `403`: 403
- `404`: 404
- `409`: 409
- `429`: 429
- `500`: 500
- `503`: 503

---

[API](https://skmtc.dev/databuddy/apis/databuddy-api.md) - [All operations](https://skmtc.dev/databuddy/apis/databuddy-api/llms.txt) - [OpenAPI document](https://skmtc.dev/databuddy/apis/databuddy-api/revisions/ddfbba648d52?raw)