---
title: "GET /v1/projects/{projectOrProductUID}/usage/events"
method: GET
path: "/v1/projects/{projectOrProductUID}/usage/events"
tags: ["usage"]
---

# GET /v1/projects/{projectOrProductUID}/usage/events

`GET /v1/projects/{projectOrProductUID}/usage/events`

Get events usage for a project with time range and period aggregation, when endDate is 0 or unspecified the current time is implied

## Path parameters

- `projectOrProductUID` string, required

## Query parameters

- `startDate` integer
- `endDate` integer
- `deviceUID` string[]
- `fleetUID` string[]
- `limit` integer
- `period` 'day' | 'week' | 'month', required
- `aggregate` 'device' | 'fleet' | 'project'
- `notefile` string[]
- `skipRecentData` boolean
- `includeNotefiles` boolean

## Response `200`

Successful operation

- UsageEventsResponse
  - `data` UsageEventsData[], required
    - `billable_events` integer — Events that are billable, this include all events except platform events
    - `device` string
    - `fleet` string
    - `notefiles` object — Count of events per notefile. Only present when includeNotefiles=true is specified.
    - `period` string, date-time, required
    - `platform_events` integer, required — Total platform events. Platform events are _log, _session, _health, and _geolocate events some of which are send from the device, some generated by notehub. These events are not billed.
    - `total_days_in_period` integer — The total number of days in this period. Useful for calculating daily averages for month period. Note that the current period will be the total number of days in the current period, including days in the future.
    - `total_devices` integer, required — Total devices represented in this count
    - `total_events` integer, required — Total events the device sent to notehub, including associated notehub generated events
    - `total_fw_updates` integer, nullable — Number of firmware updates in this period (from _health.qo DFU events)
    - `total_reboots` integer, nullable — Number of device reboots in this period (from _health.qo boot events)
    - `watchdog_events` integer, required — Watchdog events are events generated by notehub when a watchdog timer is configured for a device to indicate is has not been online for a period of time. These events are billed but should not be used to indicate a device is active, or connected, at this time.
  - `truncated` boolean — If the data is truncated that means that the parameters selected resulted in a response of over | the requested limit of data points, in order to ensure

## Other responses

- `default` — The response body in case of an API error.

---

[API](https://skmtc.net/notefile/apis/notehub-api.md) · [All operations](https://skmtc.net/notefile/apis/notehub-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/notefile/notehub-api/revisions/9c5b2b63a991/schema)