Appearance
List recordings by metadata
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.
TypeHTTP (bearer)
Example
"Bearer ak_1Q6AX5B5218353Q1AQNF2129YH5VAH02"or
Signature|Expires|KeyId + +
Signature
Signature for authentication. Use your presigned URL as the query parameters.
TypeAPI Key (query: signature)
Expires
Expiration timestamp (UNIX seconds)
TypeAPI Key (query: expires)
KeyId
Signing key identifier
TypeAPI Key (query: keyId)
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
Typeobject
Example
{
"userId": "user-123",
"plan": "pro"
}limit
Maximum number of results to return (1-100, default: 50)
Typestring
Example
"50"offset
Number of results to skip (default: 0)
Typestring
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.
Typestring
Example
"true"Responses
Successfully retrieved recordings
application/json
JSON
{
"recordings": [
{
"recordingId": "000e8400-e00b-00d0-a716-446655440000",
"timestamp": 1234567890,
"links": {
"self": "/recordings/000e8400-e00b-00d0-a716-446655440000",
"events": "/recordings/000e8400-e00b-00d0-a716-446655440000/events",
"eventsSigned": "/recordings/000e8400-e00b-00d0-a716-446655440000/events?expires=1735689600&keyId=key-2024-12&signature=a1b2c3d4e5f6..."
}
}
]
}