Docs/リファレンス/使用状況/使用状況の取得
GET/v1/usage

使用状況の取得

リクエストヘッダー · 1

認証ヘッダー。

Authorizationstring必須

本番用のAPIキー。次の形式で渡します: Bearer ax_live_…

返り値 · 200

標準の { data, meta } エンベロープ。 data は UsageOut 型です。

エンベロープ

dataUsageOut

単一の結果オブジェクト。

metaMeta

ページネーションとリクエストメタデータ。request_iddata_as_ofontology_version を含みます。

ontology_version 2.1.0replay meta.as_of · ?as_of=<token>

UsageOut

key_prefixstring

APIキーの先頭8文字(識別用)。

tierstring

現在の料金プラン(例: 'free'、'pro')。

requests_todayinteger

本日のAPIリクエスト数。

default 0
daily_limitinteger | null

現在のティアのリクエスト上限(日次)。無制限の場合はnull。

burst_limitinteger

現在のティアの秒間リクエスト上限。

default 2

エラー

標準のHTTPステータスコードに加え、{ error: { code, message } } エンベロープ内で型付きの error.code を返します。

すべてのエンドポイントは共通の型付きエラーエンベロープ({ error: { code, message } })を返します。 全コードの一覧はエラーリファレンスを参照してください。