Skip to main content
GET
/
v1
/
usage
Retrieve advanced API usage analytics
curl --request GET \
  --url https://supertoneapi.com/v1/usage \
  --header 'x-sup-api-key: <api-key>'
{
  "data": [
    {
      "starting_at": "2024-01-01T00:00:00+09:00",
      "ending_at": "2024-01-01T01:00:00+09:00",
      "results": [
        {
          "voice_id": "<string>",
          "voice_name": "<string>",
          "api_key": "<string>",
          "minutes_used": 123
        }
      ]
    }
  ],
  "next_page_token": "<string>",
  "total": 123
}
Advanced API usage with support for time bucketing, multi-dimensional breakdowns, and pagination.

​
Endpoint

https://supertoneapi.com/v1/usage

​
Notes

  • voice_id and voice_name cannot be set as breakdown_type values in the same request.
  • If no breakdown_type is specified, the response returns the total generated time for each time bucket.
  • If the UTC offset values differ between start_time and end_time, the value set in end_time will be ignored.

​
Request Parameters

NameRequiredDescriptionExample
start_timeYesStart time in RFC3339 format.2024-01-01T00:00:00+09:00
end_timeYesEnd time in RFC3339 format.2024-01-31T23:59:59+09:00
bucket_widthNoTime bucket width for aggregation. Default: day. Possible values: hour, day.day
breakdown_typeNoDimensions to break down usage data. Possible values: voice_id, voice_name, api_key.["voice_name"]
page_sizeNoNumber of results per page (1–20). Default: 10.10
next_page_tokenNoPagination token from the previous response.opaque_token

Authorizations

​
x-sup-api-key
string
header
required

Query Parameters

​
start_time
string
required

Start time in RFC3339 format

Example:

"2024-01-01T00:00:00+09:00"

​
end_time
string
required

End time in RFC3339 format

Example:

"2024-01-31T23:59:59+09:00"

​
bucket_width
enum<string>
default:day

Time bucket width for aggregation

Available options:
hour,
day
​
breakdown_type
enum<string>[]

Dimensions to break down usage data

Example:
["voice_name"]
​
page_size
number
default:10

Number of results per page

Required range: 1 <= x <= 20
​
next_page_token
string

Pagination token from previous response

Response

Usage analytics data successfully retrieved.

​
data
object[]
required

Array of time buckets containing usage data

​
total
number
required

Total number of time buckets across all pages

​
next_page_token
string

Pagination token for next page