Skip to main content
アカウント API は、使用量、クォータの状態、使用量の履歴、サブスクリプションの準備状況の読み取りと、ログアウトに使います。アカウントの読み取りには、アカウントの Bearer トークンまたはブラウザーのセッションを使います。アカウントのリクエストに、プロジェクトの取り込みキーを使わないでください。アカウントの認証情報を、SDK や取り込みの設定に使わないでください。 エラーは標準の API エラーのエンベロープを使います。有効なアカウントの認証がない読み取りは、code: "unauthorized" 付きで 401 を返します。この失敗を、使用量0、空のグラフ、無料プランとして表示しないでください。対応していないメソッドは code: "method_not_allowed" 付きで 405 を返し、next に対応しているリクエストが示されます。 アカウント API が報告するのはテレメトリの使用量で、金額ではありません。料金、請求書、支払いの状態は報告しません。

アカウントの使用量

GET /api/account/usage は、使用量とクォータの正式なエンドポイントです。使用量の合計、リセットの時刻、クォータの状態、プロジェクト別とテレメトリストリーム別の内訳にはこれを使います。SDK のファイル、CLI のファイル、クライアントのカウンターから使用量を計算しないでください。CLI のコマンド logbrew usage はこのエンドポイントを読みます。CLI リファレンスを参照してください。
合成の値を使ったレスポンスの例です。この無料アカウントにはプロジェクトが1つあり、現在の期間にはログだけを送信しています。

SDK が破棄したイベント

sdk_dropped_events も受け取るには response_version=2 を送信します。このパラメーターがない場合や response_version=1 の場合、レスポンスにこのフィールドは含まれません。
sdk_dropped_events は、現在の期間に SDK が送信前に破棄したと報告したイベントの一覧です。たとえば、クライアントのキューがいっぱいだった場合です。プロジェクトと理由の組み合わせごとに 1 行あります。
破棄されたイベントは LogBrew に届いていません。課金されず、usage、by_project、by_stream にも含まれません。破棄を報告した SDK がない場合、配列は空です。

クォータの状態

主な分岐には state を使います。limit が null になるのは、state が ok の場合だけです。 next_action.state、next_action.limit、next_action.reset_at は、トップレベルの値を繰り返します。next_action.code の値には、ターゲットが account_usage の check_usage_limits もあります。クライアントがこの組み合わせを受け取ったら、使用量をもう一度読み、next を表示します。 LogBrew は、テレメトリの種類ごとにそれぞれの上限と比べて測定します。limit はそれらを次のようにまとめます。
  • events は課題のイベントとトレースのスパンを対象とします。
  • bytes はログのバイト数とメトリクスのバイト数を対象とします。
ある上限が blocked で、別の上限が warning の場合、limit は blocked の上限を示します。使用量が上限の warning_threshold に達すると warning の状態になります。使用量が上限に達すると blocked の状態になります。 next のテキストは、プランが販売されていないときなどに変わることがあります。next_action の値は変わりません。ローカライズは next_action から行ってください。next を解析しないでください。 アカウントの使用量の上限は、API のレート制限とは別のものです。取り込みが上限を超えると、取り込みリクエストは usage_limit_exceeded 付きで 429 を返し、ボディに limit と reset_at が追加されます。このエラーでは、limit が正確な上限を示します:issue_events、log_bytes、metric_bytes、trace_spans。LogBrew はリクエスト全体を拒否します。reset_at を過ぎるか、プランが変わるまで、そのテレメトリの種類を再び送信しないでください。クライアントがリクエストを送りすぎた場合、API は rate_limited を返します。API エラーを参照してください。 レスポンスはスナップショットです。アカウントを変更したら、もう一度読みます。
GET /api/logs/usage は、モバイルの互換性のための従来のレスポンスで、bytes_used、limit_bytes、month を含みます。新しい連携には GET /api/account/usage を使ってください。

使用量の履歴

GET /api/account/usage/history は、グラフやレポート用に、件数に上限があり、空の期間を0で埋めた使用量のバケットを返します。interval には対応している値を1つ設定します。interval を省略すると、API は monthly を使います。このルートは、ほかのクエリキーを受け付けません。
この yearly のレスポンスは、2026年6月のリクエストに対する合成データです。使用量はすべて6月に発生しました。
上限のリセットには current.reset_at を使います。履歴の期間の終わりは使わないでください。current はバケットの合計ではなく、その日付は履歴の期間の日付と異なることがあります。 最後のバケットには、終わっていない現在の暦上の期間が含まれます。終了の時刻が未来でも、LogBrew が未来の使用量を測定したという意味ではありません。値が0のバケットは、LogBrew がそのバケットで使用量を数えなかったという意味です。 バケットの usage.projects は、そのバケットで使用量があるプロジェクトの数です。これらを足してプロジェクトの数を求めないでください。所有するプロジェクトの数には current.usage.projects を使います。 イベントとバイトは単位が違うため、別の系列としてグラフにします。バケットに含まれるのは使用量で、費用ではありません。グラフに支出、請求書、API リクエストといったラベルを付けないでください。 対応していない間隔は 422 を返します。
不明なクエリキーも、validation_failed 付きで 422 を返します。

サブスクリプションの準備状況

GET /api/account/subscription は読み取り専用です。有料プランや組織の操作を有効にするかどうかの判断に使います。クォータの状態には、使用量のエンドポイントを使います。
無料アカウントでは次のレスポンスが返ります。account_id は合成の値です。
next は表示用のテキストです。有料プランを販売しているかどうかで変わります。返されたテキストを表示するか、next_action からローカライズします。next からプラン名を取り出してハードコードしないでください。 列挙値: それぞれのブロック要因には、next_action の組み合わせが1つあります。 ティアの値は識別子で、表示名ではありません。ローカライズしたクライアントでも変更しないでください。有料アカウントでもブロックされることがあります。組織の作成を有効にする前に organization_creation_allowed を確認してください。 このエンドポイントは、組織の作成、招待の送信、ロールの変更、請求の変更を行いません。

ログアウト

作業に合った最も狭い範囲を選びます。これらのエンドポイントは、アカウントやそのプロジェクトの削除、取り込みキーのローテーション、サードパーティのログインプロバイダーの許可の取り消しを行いません。

1つのアプリまたは CLI のログイン

リフレッシュトークンを持っているクライアントからリクエストを送信します。Content-Type: application/json を設定します。
人やエージェントに、リフレッシュトークンを出力させたり貼り付けさせたりしないでください。成功したレスポンスは 200 です。
これは、リフレッシュトークンのファミリーを1つ無効化します。LogBrew は、そのログインでの以降のリフレッシュを拒否します。アカウントのほかのログインは変わりません。クライアントがすでに持っているアクセストークンは、期限が切れるまで有効です。アカウントの認証情報が漏えいした可能性がある場合は、すべての LogBrew のログインを使います。 レスポンスを受け取ったら、クライアントはローカルの認証情報を削除します。同じ有効なリフレッシュトークンをもう一度送信しても、レスポンスは同じ 200 です。トークンが無効、期限切れ、またはアクセストークンの場合、レスポンスは code: "unauthorized" と next_action.code: "authorize_request" 付きの 401 です。この場合も、ローカルの認証情報を削除します。logbrew logout はこのエンドポイントを使います。

すべての LogBrew のログイン

このリクエストは、アカウントのすべてのクライアントをログアウトさせます。エージェントが送信する前に、アカウントの所有者の承認を得てください。
成功したレスポンスは 200 です。
revoked_before はその時刻自体を含み、ミリ秒の精度です。LogBrew は、その時刻以前のサインインによるアクセストークン、ブラウザーのセッション、リフレッシュトークンを拒否します。そのようなサインインから後でリフレッシュしたトークンも拒否されます。現在のライブフィードのセッションは終了し、レスポンスはブラウザーのセッション Cookie を消去します。その時刻より後のサインインは有効なままです。各クライアントは、ローカルの LogBrew の認証情報を削除し、もう一度サインインする必要があります。 もう一度サインインして、このリクエストを自動で繰り返さないでください。新しいリクエストは、新しいサインインも無効化します。 レスポンスが失われた場合は、すべてのログインが無効化されたと報告しないでください。後で古い認証情報が 401 を返しても、成功のレスポンスの代わりにはなりません。その他の回復の手順は、不正利用されたアカウントを保護するを読んでください。

ブラウザーのセッション

POST /api/auth/web/logout は、ブラウザーの logbrew_session Cookie を消去し、ボディなしで 204 No Content を返します。ブラウザーから呼び出してください。セッションの Cookie をコマンドにコピーしないでください。このリクエストは、ほかのクライアントをログアウトさせず、Cookie の値のコピーも無効化しません。すべてのセッションを無効化するには、すべての LogBrew のログインを使います。

ログアウトのエラーから回復する

テレメトリのルート、フィルター、ページネーションについては、テレメトリ APIを読んでください。