---
title: "List recorded sessions"
method: POST
path: "/replays/list"
tags: ["Replays"]
---

# List recorded sessions

`POST /replays/list`

## Request

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

Lists recordings by identified-user email, profile id, current traits, recording start time, and behavior. Requires website read permission (read:data for API keys) and replay enabled. Check hasMore and truncated before treating results as exhaustive.

## Request body

- object
  - `person` string: Case-insensitive partial match on an identified user's email, name, or profile ID.
  - `email` string, email: Exact identified-user email, case-insensitive; combine with traits or profileId to narrow it.
  - `profileId` string: The stable profile ID supplied by the site with user identification.
  - `traits` object[]: Current user traits, all of which must match, such as role=editor or region=eu. These do not describe past trait values.
    - `key` string, required
    - `value` string, required
  - `startedAfter` string, date-time: Inclusive recording start timestamp with timezone.
  - `startedBefore` string, date-time: Exclusive recording start timestamp with timezone.
  - `category` 'browsing' | 'evaluating' | 'signing_up' | 'using' | 'buying' | 'support' | 'other'
  - `event` string
  - `issue` string
  - `limit` integer
  - `segment` 'all' | 'worth_watching' | 'frustrated' | 'identified' | 'long'
  - `websiteId` string, required

## Response `200`

OK

- object
  - `categories` object[], required
    - `category` 'browsing' | 'evaluating' | 'signing_up' | 'using' | 'buying' | 'support' | 'other', required
    - `sessions` number, required
  - `counts` object, required
  - `events` object[], required
    - `name` string, required
    - `sessions` number, required
  - `hasMore` boolean, required
  - `sessions` 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)