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": [
        {
          "minutes_used": 123,
          "voice_id": "<string>",
          "voice_name": "<string>",
          "api_key": "<string>",
          "model": "<string>"
        }
      ]
    }
  ],
  "total": 123,
  "next_page_token": "<string>"
}
시간 버킷팅, 다차원 분해, 페이지네이션을 지원합니다.

​
엔드포인트

https://supertoneapi.com/v1/usage

​
참고사항

  • voice_id와 voice_name은 동일한 요청에서 breakdown_type 값으로 함께 설정할 수 없습니다.
  • breakdown_type을 지정하지 않으면, 응답은 각 시간 버킷의 총 생성 시간을 반환합니다.
  • start_time과 end_time의 UTC 오프셋 값이 서로 다르면, end_time에 설정된 값은 무시됩니다.

​
요청 파라미터

NameRequiredDescriptionExample
start_timeYesRFC3339 형식의 시작 시각.2024-01-01T00:00:00+09:00
end_timeYesRFC3339 형식의 종료 시각.2024-01-31T23:59:59+09:00
bucket_widthNo집계를 위한 시간 버킷 폭. 기본값: day. 가능한 값: hour, day.day
breakdown_typeNo사용량 데이터를 분해할 차원. 가능한 값: voice_id, voice_name, api_key.["voice_name"]
page_sizeNo페이지당 결과 수(1–20). 기본값: 10.10
next_page_tokenNo이전 응답에서 받은 페이지네이션 토큰.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

Available options:
voice_id,
voice_name,
api_key,
model
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