usage

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

Changed on

Get billable Notehub API request usage for a project, broken down by endpoint and time period, when endDate is 0 or unspecified the current time is implied. Only requests that are billed against the project's plan are counted

Request

  • Base URL
    https://api.notefile.net
  • URL
    https://api.notefile.net/v1/projects/{projectOrProductUID}/usage/api
  • 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

limitinteger

Limit the number of data points returned

period'day' | 'week' | 'month' required

Period type for aggregation

Response

Response body for Notehub API request 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": [
    {
      "endpoint": "/v1/projects/{projectOrProductUID}/devices",
      "method": "GET",
      "period": "2025-07-23T00:00:00Z",
      "requests": 1284
    }
  ]
}

Changes