usage
Get events usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied
get/v1/projects/{projectOrProductUID}/usage/events
Path parameters
projectOrProductUIDstring required
Query parameters
startDateinteger
Start date for filtering results, specified as a Unix timestamp
endDateinteger
End date for filtering results, specified as a Unix timestamp
deviceUIDstring[]
A Device UID.
fleetUIDstring[]
Filter by Fleet UID
limitinteger
Limit the number of data points returned
period'day' | 'week' | 'month' required
Period type for aggregation
aggregate'device' | 'fleet' | 'project'
Aggregation level for results
notefilestring[]
Filter to specific notefiles
skipRecentDataboolean
When true, skips fetching recent data from raw event tables and only returns data from summary tables. Use this for better performance on large projects.
includeNotefilesboolean
Include per-notefile event counts in the response
Response
Successful operation
Example response
{
"data": [
{
"billable_events": 10,
"device": "dev:123456789012345",
"fleet": "fleet:1042ddc5-3b2c-4cec-b1fb-d3040538094d",
"notefiles": {
"_log.qo": 20,
"customer1.qo": 1,
"session.qo": 50
},
"period": "2025-07-23T00:00:00Z",
"platform_events": 15,
"total_events": 42,
"total_fw_updates": 1,
"total_reboots": 2,
"watchdog_events": 10
}
]
}