Skip to main content
The Fleet Events resource allows you to create, retrieve, and manage events associated with device recordings.

​
List events

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

​
Parameters

​
options
ListEventsOptions
Optional filtering and pagination parameters
​
recording
string
Filter events by recording UID
​
device
string
Filter events by device UID
​
type
string
Filter events by type
​
severity
string
Filter events by severity level
​
limit
number
Maximum number of events to return per page
​
cursor
string
Cursor for pagination

​
Returns

​
items
FleetEvent[]
Array of fleet events
​
uid
string
Unique identifier for the event
​
recording
string | null
UID of the associated recording
​
device
string | null
UID of the associated device
​
type
string | null
Event type
​
label
string | null
Event label
​
description
string | null
Event description
​
timestamp
string | null
Event timestamp
​
durationMs
number | null
Event duration in milliseconds
​
tags
string[]
Event tags
​
metadata
Record<string, unknown> | null
Custom event metadata
​
severity
string | null
Event severity level
​
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

​
Create event

Create a new fleet event. 
const event = await client.fleet.events.create(options);

​
Parameters

​
options
CreateEventOptions
required
Event creation details
​
recording
string
required
UID of the associated recording
​
device
string
required
UID of the associated device
​
label
string
required
Event label
​
type
string
required
Event type
​
timestamp
string
required
Event timestamp (ISO 8601 format)
​
description
string
Event description
​
durationMs
number
Event duration in milliseconds
​
tags
string[]
Event tags
​
metadata
Record<string, unknown>
Custom event metadata
​
severity
string
Event severity level

​
Returns

​
FleetEvent
object
The newly created event

​
Create batch events

Create multiple events in a single request. 
const result = await client.fleet.events.createBatch(events);

​
Parameters

​
events
CreateEventOptions[]
required
Array of event creation options

​
Returns

​
created
number
Number of events successfully created

​
Get event

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

​
Parameters

​
uid
string
required
The unique identifier of the event

​
Returns

​
FleetEvent
object
The requested event

​
Delete event

Delete an event from your fleet. 
await client.fleet.events.delete(uid);

​
Parameters

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

​
Returns

Returns void on success.

Build docs developers (and LLMs) love

Get started for freeTalk to us