Sign in

v1

latestOpenAPI 3.0.02026-07-26152942.8 KB
usage

Retrieve advanced API usage analytics

Retrieves API usage data with advanced features including time bucketing, multi-dimensional breakdowns, and pagination. All timestamps should be in RFC3339 format.

get/v1/usage

Query parameters

start_timestring required
Example:2024-01-01T00:00:00+09:00

Start time in RFC3339 format

end_timestring required
Example:2024-01-31T23:59:59+09:00

End time in RFC3339 format

bucket_width'hour' | 'day'

Time bucket width for aggregation

breakdown_typestring[]

Dimensions to break down usage data

[
  "voice_name"
]
page_sizenumber

Number of results per page

next_page_tokenstring

Pagination token from previous response

Response

Usage analytics data successfully retrieved.

next_page_tokenstring

Pagination token for next page

totalnumber required

Total number of time buckets across all pages

Example response

{
  "data": [
    {
      "starting_at": "2024-01-01T00:00:00+09:00",
      "ending_at": "2024-01-01T01:00:00+09:00"
    }
  ]
}