Skip to main content
The Fleet Recordings resource allows you to list, retrieve, update, and delete recordings from your fleet devices.

​
List recordings

Retrieve a paginated list of fleet recordings. 
const recordings = await client.fleet.recordings.list(options?);

​
Parameters

​
options
ListRecordingsOptions
Optional filtering and pagination parameters
​
device
string
Filter recordings by device UID
​
status
string
Filter recordings by status
​
limit
number
Maximum number of recordings to return per page
​
cursor
string
Cursor for pagination

​
Returns

​
items
FleetRecording[]
Array of fleet recordings
​
uid
string
Unique identifier for the recording
​
device
string | null
UID of the device that created this recording
​
status
string | null
Recording status
​
durationSeconds
number | null
Recording duration in seconds
​
sizeBytes
number | null
Recording size in bytes
​
topicCount
number
Number of topics in the recording
​
tags
string[]
Recording tags
​
topics
Array<Record<string, unknown>> | null
List of topics in the recording
​
startedAt
string | null
Recording start timestamp
​
endedAt
string | null
Recording end timestamp
​
createdAt
string | null
Creation timestamp
​
updatedAt
string | null
Last update timestamp
​
nextCursor
string | null
Cursor for the next page of results
​
previousCursor
string | null
Cursor for the previous page of results
​
hasMore
boolean
Whether more results are available

​
Get recording

Retrieve a specific recording by UID. 
const recording = await client.fleet.recordings.get(uid);

​
Parameters

​
uid
string
required
The unique identifier of the recording

​
Returns

​
FleetRecording
object
The requested recording

​
Update recording

Update an existing recording. 
const recording = await client.fleet.recordings.update(uid, options);

​
Parameters

​
uid
string
required
The unique identifier of the recording
​
options
UpdateRecordingOptions
required
Fields to update
​
status
string
Updated recording status
​
tags
string[]
Updated recording tags

​
Returns

​
FleetRecording
object
The updated recording

​
Delete recording

Delete a recording from your fleet. 
await client.fleet.recordings.delete(uid);

​
Parameters

​
uid
string
required
The unique identifier of the recording to delete

​
Returns

Returns void on success.

Build docs developers (and LLMs) love

Get started for freeTalk to us