Sign in

v9

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01211389.1 KB

Usage data

Generate an hourly consumption report.

get/usage

Query parameters

fromstring date-time required
Example:2025-12-24T18:00:00-06:00

The ISO datetime to select data starting from, inclusively.

tostring date-time required
Example:2025-12-25T9:00:00-06:00

The ISO datetime to select data up to, inclusively.

emailstring[]

[Whitelabelers only] The (case-insensitive) email address of the user whose data to select; multiple addresses can be provided by repeating the key; data for all addresses is selected by default.

[
  "user@example.com"
]
serviceService[]

The service to select data for; multiple services can be provided by repeating the key; data for all services is selected by default.

[
  "search",
  "browser"
]
by'hour' | 'day (planned)' | 'total'
Example:total

The time unit to group the data by.

Response

The hourly report.

emailstring email required

The email address of the user whose data is selected.

fromstring date-time required

The ISO datetime of the first datapoint.

tostring date-time required

The ISO datetime of the last datapoint.

service'search' | 'browser' required
result'success' | 'failure' required

The type of result included in the data.

callsinteger required

The number of API calls of the service and result type.

creditsinteger required

The number of credits consumed by the API calls.

meanSecsnumber required

The average number of elapsed seconds of the API calls.

Example response

[
  {
    "email": "user@example.com",
    "from": "2025-12-25T00:00:00+00:00",
    "to": "2025-12-25T15:00:00+00:00",
    "service": "browser",
    "result": "success",
    "calls": 17208,
    "credits": 17208,
    "meanSecs": 6.78
  }
]