Skip to content

List recordings

GET
/recordings

Query recordings by metadata filters or by most recent. Multiple filters are combined with AND logic.

Authorizations

Private API Key
Bearer token for authentication. Use your private API key as the token.

Parameters

Query Parameters

meta

Filter recordings by metadata key-value pairs. Use meta[key]=value syntax (URL-encode keys and values with encodeURIComponent). eg. meta[userId]=user-123&meta[plan]=pro

Type
object
Example{ "userId": "user-123", "plan": "pro" }
limit

Maximum number of results to return (1-100, default: 50)

Type
string
Example"50"
offset

Number of results to skip (default: 0)

Type
string
Example"0"
includeSignedUrls

Include presigned URLs in the response (default: false). When enabled, generates authenticated URLs for recording events that can be used without additional authentication.

Type
string
Example"true"

Responses

Successfully retrieved recordings

application/json
JSON
{
"recordings": [
{
"recordingId": "550e8400-e29b-41d4-a716-446655440000",
"timestamp": 1234567890,
"links": {
"self": "/recordings/550e8400-e29b-41d4-a716-446655440000",
"events": "/recordings/550e8400-e29b-41d4-a716-446655440000/events",
"eventsSigned": "/recordings/550e8400-e29b-41d4-a716-446655440000/events?expires=1735689600&keyId=key-2024-12&signature=a1b2c3d4e5f6..."
},
"metadata": {
"additionalProperties": "string"
}
}
]
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI