アカウントログを照会する
GET /api/open/v1/logsリクエストパラメーター
Section titled “リクエストパラメーター”| パラメーター | 位置 | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|---|
start_timestamp | query | integer | いいえ | 下記参照 | 開始時刻(含む)、unix 秒 |
end_timestamp | query | integer | いいえ | 下記参照 | 終了時刻(含む)、unix 秒 |
model_name | query | string | いいえ | — | モデル名の完全一致。複数指定する場合はパラメーターを繰り返します(?model_name=a&model_name=b)。カンマ区切りにも対応 |
key_name | query | string | いいえ | — | Key 名の完全一致。複数指定する場合はパラメーターを繰り返します。名前にカンマを含められるためカンマ区切りは未対応 |
key_id | query | integer | いいえ | — | Key ID(正の整数)。パラメーターを繰り返すかカンマ区切りで指定。他ユーザーの ID は空の結果になります |
type | query | integer | いいえ | 2 | ログの種類。2 は消費(課金)リクエスト、7 は最終的に失敗したリクエスト(課金なし)。パラメーターを繰り返すかカンマ区切りで指定します(?type=2,7)。それ以外の値は 400 |
p | query | integer | いいえ | 1 | ページ番号。1–1000000 |
page_size | query | integer | いいえ | 10 | 1 ページあたりの件数。1–1000 |
時間範囲のルール:
- 両方とも省略: 直近 30 日間。
start_timestampのみ指定: そこから 30 日後まで。ただし現在時刻を超えません。end_timestampのみ指定: そこから 30 日前まで。- 範囲は最大 366 日です。
複数値パラメーターはそれぞれ最大 50 個までです。超えると 400 invalid_request を返します。明示的に指定した不正な p / page_size は 400 を返します。詳細は ページネーション を参照してください。タイムスタンプは非負の整数である必要があり、そうでない場合は 400 を返します。
リクエスト例
Section titled “リクエスト例”curl "https://www.routeapi.ai/api/open/v1/logs?start_timestamp=1726408000&end_timestamp=1729000000&key_name=bot&model_name=gpt-4o&p=1&page_size=20" \ -H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"レスポンス例
Section titled “レスポンス例”{ "success": true, "message": "", "data": { "items": [ { "id": 12345, "created_at": 1729000000, "type": 2, "key_id": 12, "key_name": "bot", "key": "sk-abcd**********wxyz", "model_name": "gpt-4o", "prompt_tokens": 1200, "completion_tokens": 300, "total_tokens": 1500, "amount": 0.05, "use_time": 3, "is_stream": true, "first_response_ms": 420, "cache_read_tokens": 800, "cache_creation_tokens": 0, "reasoning_effort": "medium", "request_path": "/v1/chat/completions", "web_search_calls": 0, "audio_input_tokens": 0, "audio_output_tokens": 0, "billing_source": "wallet", "request_id": "20261020120000123456789" } ], "total": 1, "page": 1, "page_size": 20, "start_timestamp": 1726408000, "end_timestamp": 1729000000 }}レスポンスフィールド
Section titled “レスポンスフィールド”| フィールド | 型 | 説明 |
|---|---|---|
items[].id | integer | ログ ID |
items[].created_at | integer | 記録日時、unix 秒 |
items[].type | integer | 2 は消費、7 は最終的な失敗 |
items[].key_id | integer | リクエストを発行した Key の ID |
items[].key_name | string | リクエスト時点の Key 名 |
items[].key | string | API Key を一覧表示する と同じ形式のマスクされた Key 値(例: sk-abcd**********wxyz)。Key が完全に削除済みの場合は空文字列 |
items[].model_name | string | モデル名 |
items[].prompt_tokens | integer | 入力トークン数 |
items[].completion_tokens | integer | 出力トークン数 |
items[].total_tokens | integer | 入力と出力のトークン合計 |
items[].amount | number | 今回消費した金額。サイトの表示通貨、小数点以下 2 桁。金額が非常に小さい場合は 0.00 になることがあります |
items[].use_time | integer | リクエストの所要時間(秒) |
items[].is_stream | boolean | ストリーミングで処理されたかどうか |
items[].first_response_ms | integer | 最初の応答までの時間(ミリ秒)。不明な場合(非ストリーミングなど)は 0 |
items[].cache_read_tokens | integer | プロンプトキャッシュの読み取りトークン数 |
items[].cache_creation_tokens | integer | プロンプトキャッシュの書き込みトークン数 |
items[].reasoning_effort | string | 推論の強度(low / medium / high など)。未設定の場合は空文字列 |
items[].request_path | string | リクエストパス(例: /v1/chat/completions) |
items[].web_search_calls | integer | リクエスト中に実行された Web 検索の回数 |
items[].audio_input_tokens | integer | 音声入力トークン数 |
items[].audio_output_tokens | integer | 音声出力トークン数 |
items[].billing_source | string | wallet はウォレット残高、subscription はサブスクリプション、不明な場合は空文字列 |
items[].request_id | string | リクエスト ID。トラブルシューティングに利用できます |
total | integer | 条件に一致するログの総数。最大 10000 までカウント |
page | integer | 現在のページ番号 |
page_size | integer | 実際に適用された 1 ページあたりの件数 |
start_timestamp | integer | 実際に適用された開始時刻 |
end_timestamp | integer | 実際に適用された終了時刻 |
| HTTP | code | シナリオ |
|---|---|---|
| 400 | invalid_request | タイムスタンプが数値でないか負の値、時間範囲が 366 日を超える、start_timestamp が end_timestamp より大きい、ページネーションが不正、複数値パラメーターが 50 個を超える、key_id が正の整数ではない、または type が 2 でも 7 でもない |
| 429 | — | ユーザーごとの照会レート制限(デフォルト 30 回/分)を超過。レスポンスボディが空の場合があります |
その他の共通エラーコードは プラットフォーム API のエラー を参照してください。
- デフォルトでは消費(課金)ログのみを返します。最終的に失敗したリクエスト(課金なし)も含めるには
type=2,7を指定してください。 - 結果は記録時刻の降順(
created_at降順)で並びます。同じ時刻の記録はログ ID の降順で並ぶため、ページ送りは安定します。 key_nameはリクエスト時点の Key 名です。Key の名前を変更しても過去の記録は書き換えられません。keyはマスクされた値です。Key がその後完全に削除された場合は空文字列になります。use_time、first_response_ms、キャッシュ、検索、音声、推論の各フィールドは、対応するデータが記録されていない場合0または空文字列になります。フィールド自体は常に含まれます。- トークン数は実数で、百万単位ではありません。
- 金額はサイトの表示通貨で表されます。残高を照会する を参照してください。
- このエンドポイントは ログのエクスポート、使用量統計、モデル別使用量、Key 別使用量 とユーザーごとの照会レート制限(デフォルト 30 回/分)を共有します。レート制限 を参照してください。
- 一致するすべての行を一度にエクスポート(CSV または JSONL)する場合は、このエンドポイントをページ送りして連結するのではなく ログのエクスポート を使用してください。