使用状況を取得

指定期間の支出/リクエスト数/トークン統計を、モデル別、API キー別、アプリ名(app_name)別の 3 つの軸で分けて返し、さらに日次の時系列も含みます。/v1/insights と異なり、このエンドポイントには上位モデルランキング、キャッシュ統計、年間ヒートマップはありません——より軽量な集計エンドポイントで、カスタム日付範囲(period=custom)に対応しています。

GET/api/v1/usage

認証

Authorization必須

string · header

Authorization ヘッダーに Bearer トークンとして API キーを渡します。

クエリパラメータ

period

string

統計期間、デフォルトは month。3 種類:従来の暦語(day/week/month/year)、現在を終点とするローリングウィンドウ(15m…1y)、暦に整列した期間(today…prev_year)、または custom(from/to が必要)。認識できない値は 400 を返します。

dayweekmonthyear15m30m1h3h1d2d1w1mo1ytodayyesterdaythis_weekprev_weekthis_monthprev_monththis_yearprev_yearcustom

Example: "month"

from

string

カスタム期間の開始(ISO 8601)。period=custom のときのみ使用されます。

ISO 8601, required with period=custom

Example: "2026-07-01T00:00:00.000Z"

to

string

カスタム期間の終了(ISO 8601)。period=custom のときのみ使用されます。

ISO 8601, required with period=custom

Example: "2026-07-27T00:00:00.000Z"

GET /api/v1/usage

1
2
curl "https://bazaarlink.ai/api/v1/usage?period=month" \
  -H "Authorization: Bearer $BAZAARLINK_API_KEY"

レスポンス例

成功。totals は期間の集計値です。byModel/byKey/byApp は 3 つの独立した内訳です(入れ子関係ではありません)。timeSeries はモデルごとに分割された日次の支出/トークン/リクエスト数の系列です。以下は抜粋例です。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{
  "period": "month",
  "since": "2026-07-01T00:00:00.000Z",
  "until": "2026-07-27T12:00:00.000Z",
  "credits": 42.5,
  "totals": {
    "spend": 4.82,
    "requests": 340,
    "tokens": 152000,
    "promptTokens": 120000,
    "completionTokens": 32000
  },
  "byModel": [
    {
      "model": "openai/gpt-4.1",
      "spend": 4.82,
      "tokens": 152000,
      "requests": 340
    }
  ],
  "byKey": [
    {
      "keyId": "key_abc123",
      "keyName": "default",
      "spend": 4.82,
      "tokens": 152000,
      "requests": 340,
      "spendLimitUsd": null,
      "spendLimitPeriod": null
    }
  ],
  "byApp": [
    {
      "appName": "my-app",
      "spend": 4.82,
      "tokens": 152000,
      "requests": 340
    }
  ],
  "timeSeries": [
    {
      "date": "2026-07-01",
      "model": "openai/gpt-4.1",
      "cost": 0.16,
      "tokens": 5200,
      "requests": 12
    }
  ]
}