Skip to content

Search recordings​

GET
/search/recordings

Return a page of recordings that match every filter you set, in the order you choose, and how many match in total.

Authorizations

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

Parameters​

Query Parameters

search

Return recordings whose ID, a metadata value, or the title or friction summary of their session narration contains this text. Matching ignores case.

Type
string
Example"checkout"
Max Length
200
narration

friction returns recordings whose latest session narration found possible friction. none returns recordings without a session narration.

Type
string
Valid values
"friction""none"
from

Return recordings whose last event happened at or after this time, in epoch milliseconds.

Type
integer
Example1762905600000
Minimum
0
to

Return recordings whose last event happened before this time, in epoch milliseconds. Must be later than from.

Type
integer
Example1763510400000
Minimum
0
minDurationMs

Return recordings at least this long, in milliseconds from the first event to the last.

Type
integer
Example30000
Minimum
0
maxDurationMs

Return recordings at most this long, in milliseconds from the first event to the last.

Type
integer
Example600000
Minimum
0
minClicks

Return recordings with at least this many clicks.

Type
integer
Example1
Minimum
0
maxClicks

Return recordings with at most this many clicks.

Type
integer
Example100
Minimum
0
minBytes

Return recordings whose events take up at least this many bytes.

Type
integer
Example1000000
Minimum
0
maxBytes

Return recordings whose events take up at most this many bytes.

Type
integer
Example5000000
Minimum
0
sort

newest and oldest order recordings by their last event. longest puts the longest recordings first.

Type
string
Valid values
"newest""oldest""longest"
Default
"newest"
limit

Maximum number of recordings to return.

Type
integer
Minimum
1
Maximum
100
Default
50
offset

Number of matching recordings to skip.

Type
integer
Minimum
0
Default
0
metadata

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

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

Responses​

A page of matching recordings, and how many match in total

application/json
JSON
{
  
"recordings": [
  
  
{
  
  
  
"recordingId": "550e8400-e29b-41d4-a716-446655440000",
  
  
  
"timestamp": 1762905600000,
  
  
  
"durationMs": 65432,
  
  
  
"metadata": {
  
  
  
  
"additionalProperties": "string"
  
  
  
},
  
  
  
"statistics": {
  
  
  
  
"fullSnapshotCount": 0,
  
  
  
  
"metaCount": 0,
  
  
  
  
"clickCount": 0,
  
  
  
  
"totalBytes": 0
  
  
  
}
  
  
}
  
],
  
"total": 128
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI