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>"
}
このドキュメントは英語の原文から自動翻訳されています。表現に不自然な箇所がある場合があります。正確な内容は英語の原文もあわせてご確認ください。
生成オーディオの分数を時間バケットに集計し、必要に応じてボイス、API キー、モデル別に内訳化して返します。ダッシュボード、社内レポート、キー別の課金按分などにご利用ください。 日付ごとのシンプルなボイス単位の集計が必要な場合は、代わりに ボイス使用量取得 をご利用ください。

​
エンドポイント

GET https://supertoneapi.com/v1/usage

​
クエリパラメータ

NameRequiredDescriptionExample
start_time✅RFC3339 形式の開始時刻です。2025-05-01T00:00:00+00:00
end_time✅RFC3339 形式の終了時刻です。2025-05-31T23:59:59+00:00
bucket_width—hour または day。デフォルトは day。day
breakdown_type—内訳ディメンションの配列: voice_id、voice_name、api_key、model。["voice_name"]
page_size—1 ページあたりの件数（1〜20）です。デフォルト 10。10
next_page_token—前回のレスポンスから取得したトークンです。eyJpZCI6IjEyMzQ1In0=

​
制約事項

  • voice_id と voice_name を 同時に breakdown_type に指定することはできません。
  • start_time と end_time の UTC オフセットが異なる場合、end_time のオフセットは無視されます。両者で一致するオフセットをご使用ください。
  • breakdown_type を省略すると、レスポンスはバケットごとの合計生成時間のみを返します（ディメンション別の内訳は含まれません）。

​
関連項目

Docs: Cost and usage

本番環境でのコスト監視パターン。

Get voice usage

日付別のシンプルなボイス単位の集計。

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