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
}
時間バケット化、多次元ブレークダウン、ページネーションをサポートします。

​
エンドポイント

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_sizeNo1 ページあたりの結果数 (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

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