NOnotefile
usage

GET /v1/projects/{projectOrProductUID}/usage/data

Changed on

Get data usage in bytes for a project with time range and period aggregation

Request

  • Base URL
    https://api.notefile.net
  • URL
    https://api.notefile.net/v1/projects/{projectOrProductUID}/usage/data
  • Auth
    HTTP bearer

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

Response

Response body for Data Usage

truncatedboolean

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

Example response

{
  "data": [
    {
      "data": [
        {
          "downlink_bytes": 524288,
          "period": "2025-07-23T00:00:00Z",
          "total_bytes": 1048576,
          "uplink_bytes": 524288
        }
      ],
      "device": "dev:123456789012345",
      "fleet": "fleet:1042ddc5-3b2c-4cec-b1fb-d3040538094d",
      "iccid": "12345678901234567890",
      "psid": "skylo:5746354465786"
    }
  ]
}

Changes

  • 1f4693048cb8Revision changes
    • breaking

      for the query request parameter limit, the format changed from no format to int32

  • 1887e880199aRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status