管理

APIキー使用量の取得

ユーザーAPIキーのページネーションされた使用状況詳細を返します。

GEThttps://api.tokenlab.sh/v1/management/api-keys/{keyId}/usage

概要

特定のAPIキーの使用状況レコードをページネーション形式で返します。

クエリパラメータ

パラメータ型デフォルト / 制限備考
pageintegerデフォルト 1、最小 11から始まるページ番号
limitintegerデフォルト 50、最小 1、最大 100ページサイズ
modelstring最大長 100要求されたモデル名
modelVendorstring最大長 100公開モデルベンダー
sceneenum-chat, image, audio, video, embedding, rerank, translation, music, 3d, realtime, systemone
startDatestring-範囲の開始(含む)。タイムゾーン付きのRFC3339、または YYYY-MM-DD(UTC 00:00)を受け付けます
endDatestring-範囲の終了(含む)。RFC3339または YYYY-MM-DD を受け付けます。日付のみの場合はその日の開始(UTC 00:00)を意味するため、一日全体を含めるには翌日の日付またはRFC3339形式の時間を使用してください

startDate と endDate の両方が指定されている場合、startDate は endDate より前か同じである必要があります。

備考

  • 金額フィールドはUSDのみです。

  • レスポンスはページネーションされます。

  • 確定済みレコードには billing_transaction_id が含まれる場合があります。課金とリクエストを照合する必要がある場合は、request_id と共に保存してください。

  • レコードは created_at の降順(新しい順)でソートされます。

  • 429 ステータスコードで report_busy が返された場合は、レポートキューが一杯であることを意味します。Retry-After 秒後に再試行してください。

例

リクエスト

cURL
curl "https://api.tokenlab.sh/v1/management/api-keys/key_abc123def456/usage?page=1&limit=20&scene=chat&startDate=2026-07-01&endDate=2026-07-31T23:59:59Z" \
  -H "Authorization: Bearer mt-your-management-token"

リクエスト / レスポンス

このページでは、OpenAPIスキーマとコピー可能なリクエスト例を提供しています。管理リクエストはターミナルまたはクライアントからManagement Tokenを使用して送信してください。このページから直接送信することはできません。

レスポンス例

レスポンス

200 OK
{
  "api_key": {
    "id": "key_abc123def456",
    "name": "Backend Worker",
    "key_prefix": "sk-live...",
    "status": "active",
    "limit_amount": 500,
    "limit_amount_decimal": "500",
    "used_amount": 148.25,
    "used_amount_decimal": "148.25",
    "models": [
      "gpt-5.6-luna",
      "claude-sonnet-4-6"
    ],
    "expires_at": "2026-12-31T23:59:59.000Z",
    "last_used_at": "2026-07-08T03:12:45.000Z",
    "created_at": "2026-07-01T10:00:00.000Z",
    "delivery_policy": null
  },
  "items": [
    {
      "request_id": "req_abc123",
      "billing_transaction_id": "billtxn_abc123",
      "model": "gpt-5.6-luna",
      "logical_model": "gpt-5.6-luna",
      "model_vendor": "OpenAI",
      "scene": "chat",
      "usage_unit": "per_token",
      "usage_quantity": 1500,
      "usage_quantity_decimal": "1500",
      "prompt_tokens": 1000,
      "completion_tokens": 500,
      "total_tokens": 1500,
      "cache_read_tokens": 0,
      "cache_write_tokens": 0,
      "cache_write_tokens_5m": 0,
      "cache_write_tokens_1h": 0,
      "cost": 0.0012,
      "cost_decimal": "0.0012",
      "created_at": "2026-07-08T03:15:00.000Z",
      "requested_policy": null,
      "resolved_tier": null,
      "charged_price_basis": null
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 1,
    "totalPages": 1
  },
  "summary": {
    "total_requests": 1,
    "total_cost": 0.0012,
    "total_cost_decimal": "0.0012",
    "total_prompt_tokens": 1000,
    "total_completion_tokens": 500,
    "total_tokens": 1500,
    "usage_unit_breakdown": [
      {
        "usage_unit": "per_token",
        "usage_quantity": 1500
      }
    ]
  },
  "breakdowns": {
    "by_model": [
      {
        "model": "gpt-5.6-luna",
        "logical_model": "gpt-5.6-luna",
        "model_vendor": "OpenAI",
        "requests": 1,
        "cost": 0.0012,
        "cost_decimal": "0.0012",
        "usage_quantity": 1500,
        "usage_quantity_decimal": "1500"
      }
    ],
    "by_logical_model": [
      {
        "model": "gpt-5.6-luna",
        "logical_model": "gpt-5.6-luna",
        "model_vendor": "OpenAI",
        "requests": 1,
        "cost": 0.0012,
        "cost_decimal": "0.0012",
        "usage_quantity": 1500,
        "usage_quantity_decimal": "1500"
      }
    ],
    "by_model_vendor": [
      {
        "model_vendor": "OpenAI",
        "requests": 1,
        "cost": 0.0012
      }
    ],
    "by_scene": [
      {
        "scene": "chat",
        "requests": 1,
        "cost": 0.0012,
        "cost_decimal": "0.0012"
      }
    ],
    "daily_cost": [
      {
        "date": "2026-07-08T00:00:00.000Z",
        "cost": 0.0012,
        "cost_decimal": "0.0012"
      }
    ]
  }
}

重要なフィールド

api_keyobject
リスト/作成/更新レスポンスと同じフィールドを使用したAPIキーの概要。
itemsarray
ページネーションされた使用状況行。
paginationobject
page、limit、total、totalPages を含むページネーションメタデータ。
summaryobject
選択したフィルタの集計合計。
breakdownsobject
選択したフィルタの集計内訳。
items[].request_idstring | null
サポートおよび照合のための公開リクエスト識別子。
items[].billing_transaction_idstring | null
利用可能な場合の確定済み請求トランザクションID。
items[].modelstring
要求された公開モデル名。
items[].logical_modelstring
レポートに使用される論理公開モデル。
items[].model_vendorstring | null
公開モデルベンダー。
items[].scenestring | null
公開リクエストシーン。
items[].usage_unitstring
per_token などの課金使用単位。
items[].usage_quantitynumber
表示用のJSON数値としての使用量。
items[].usage_quantity_decimalstring
10進数文字列としての正確な使用量。
items[].prompt_tokensnumber
プロンプトトークン数。
items[].completion_tokensnumber
コンプリショントークン数。
items[].total_tokensnumber
合計トークン数。
items[].cache_read_tokensnumber
キャッシュ読み取りトークン数。
items[].cache_write_tokensnumber
キャッシュ書き込みトークン合計数。
items[].cache_write_tokens_5mnumber
5分間キャッシュ書き込みトークン数。
items[].cache_write_tokens_1hnumber
1時間キャッシュ書き込みトークン数。
items[].costnumber
表示用のJSON数値としてのUSDコスト。
items[].cost_decimalstring
10進数文字列としての正確なUSDコスト。
items[].requested_policystring | null
auto, verified, official, null。記録されている場合の要求された配信ポリシー。
items[].resolved_tierstring | null
verified, official, null。記録されている場合に使用された配信ティア。
items[].charged_price_basisobject | null
記録されている場合の適用価格および課金対象数量。ツール料金が発生するリクエストの場合、measure.dimensions に webSearchCalls または groundedPrompts が含まれ、effectiveUnitPrices に各呼び出しの価格が webSearch または groundedPrompt として含まれます。
items[].created_atstring
ISO形式の使用状況行タイムスタンプ。
summary.total_requestsnumber
合計リクエスト数。
summary.total_costnumber
表示用のJSON数値としての合計USDコスト。
summary.total_cost_decimalstring
10進数文字列としての正確な合計USDコスト。
summary.total_prompt_tokensnumber
合計プロンプトトークン数。
summary.total_completion_tokensnumber
合計コンプリショントークン数。
summary.total_tokensnumber
合計トークン数。
summary.usage_unit_breakdownarray
使用単位ごとにグループ化された使用量。
breakdowns.by_modelarray
要求された公開モデルごとの内訳。
breakdowns.by_logical_modelarray
論理公開モデルごとの内訳。
breakdowns.by_model_vendorarray
公開モデルベンダーごとの内訳。
breakdowns.by_scenearray
公開リクエストシーンごとの内訳。
breakdowns.daily_costarray
日次コストの推移。

認証

ManagementTokenAuth
AuthorizationBearer <token>

管理トークン認証。Dashboard > API > Management Tokensで管理トークンを作成または管理します。

場所: header

パスパラメータ

keyId*string

クエリパラメータ

page?integer

1から始まるページ番号。デフォルトは1です。

範囲1 <= value
デフォルト1
limit?integer

ページサイズ。デフォルトは50、最大は100です。

範囲1 <= value <= 100
デフォルト50
model?string

リクエストされたモデル名によるフィルタリング。最大長100。

長さlength <= 100
modelVendor?string

公開モデルベンダーによるフィルタリング。最大長100。

長さlength <= 100
scene?string

公開リクエストシーンによるフィルタリング。

指定できる値

  • "chat"
  • "image"
  • "audio"
  • "video"
  • "embedding"
  • "rerank"
  • "translation"
  • "music"
  • "3d"
  • "realtime"
  • "systemone"
startDate?string

下限値(境界値を含む)。タイムゾーン付きのRFC3339(例:2026-03-28T00:00:00+08:00)またはYYYY-MM-DD(UTCの00:00を意味する)を受け付けます。

endDate?string

上限値(境界値を含む)。タイムゾーン付きのRFC3339(例:2026-03-28T23:59:59+08:00)またはYYYY-MM-DD(その日の開始時のUTC 00:00を意味する)を受け付けます。一日全体を含めるには、翌日の日付またはその日の終わりのRFC3339時刻を渡してください。

レスポンス

application/json

application/json

application/json

application/json

application/json

application/json