Supertone icon

Supertone

Interact with Supertone API for AI voice synthesis

Account → Get Usage

AI-generated

Summary

Get usage analytics with time bucketing

Inputs

  • startTime (required) — Start time for usage data (RFC3339 format)
  • endTime (required) — End time for usage data (RFC3339 format)
  • bucketWidth — Time bucket width for aggregation. Options: day, hour. Default: day
  • breakdownType — Dimensions to break down usage data. Options: voice_id, voice_name, api_key, model. Note: voice_id and voice_name cannot be used together. Default: [] (none)
  • pageSize — Number of results per page (1-20). Default: 10
  • requestOptions — Additional request settings: batching, proxy, timeout, SSL verification

Output shape

Array of usage records, each containing bucketed time intervals and counts per breakdown dimension. Pagination applied according to pageSize.

Operation sends a GET request to /usage with query parameters start_time, end_time, bucket_width, breakdown_type (JSON string), and page_size.

Examples

Example 1: Retrieve daily usage broken down by API key for the last week

Set startTime to 7 days ago, endTime to now, bucketWidth = Day, breakdownType = ['api_key'], pageSize = 20

Links

Discussion