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

エンドポイント

クエリパラメータ

制約事項

  • voice_idvoice_name同時に breakdown_type に指定することはできません。
  • start_timeend_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:
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