メインコンテンツへスキップ
GET
/
api
/
v2alpha
/
analytics
/
active-users
アクティブユーザー分析を取得する
curl --request GET \
  --url https://server.codeium.com/api/v2alpha/analytics/active-users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "active_users": 142
    }
  ],
  "pagination": {
    "next_page_cursor": null
  },
  "metadata": {
    "data_freshness": "2026-01-16T03:00:00.000Z",
    "query_time_ms": 612,
    "team_id": "team_abc123"
  }
}
これは、リクエストボディで サービスキー を使用する v1 Analytics API とは異なり、Bearer トークン認証とクエリパラメータを使用する v2 エンドポイントです。詳しくは以下の認証を参照してください。
このエンドポイントは、リアルタイムでの使用量監視を目的としたものではありません。データは1時間単位で集計され、 レート制限も厳しく設定されています (チームごとに1時間あたり10リクエスト) 。定期的なレポートや一括エクスポートに利用してください。

​
認証

このエンドポイントでは Bearer トークン 認証を利用します。Authorization ヘッダーにサービスキーを含めてください。 
Authorization: Bearer <your_service_key>
サービスキーには Analytics Read 権限が必要です。チーム設定の「Service Keys」から作成してください。

​
アクティブユーザーと見なされる条件

ある時間バケット内に課金イベントが1件でもある場合、そのユーザーはその時間バケットにおいてアクティブとしてカウントされます。active_users フィールドには、重複のないユーザー数が記録されます。

​
グループ化と粒度

返されるデータの形式を制御するには、granularity と group_by を利用します。
  • 粒度やグループ化の指定なし — 指定した日付範囲全体におけるアクティブユーザーの合計数を 1 行で返します
  • granularity=daily — 各行に YYYY-MM-DD 形式の timestamp が含まれます (デイリーアクティブユーザー)
  • granularity=monthly — 各行に YYYY-MM 形式の timestamp が含まれます (マンスリーアクティブユーザー)
  • group_by=user — アクティブユーザーごとに 1 行ずつ返し、各行に user_id が含まれます。各行の active_users は 1 です
消費量を取得 とは異なり、アクティブユーザー エンドポイントでは group_by に指定できるのは user のみです。その他のディメンション (model_uid、ide) はここでは無効です。
結果は、デフォルトで 1,000 件 (最大 10,000 件) ずつページ分けされます。さらに結果がある場合、 レスポンスの pagination オブジェクトに next_page_cursor が含まれます。これを page_cursor クエリ パラメータとして渡すと、次のページを取得できます。 ページカーソルは 24 時間で期限切れになります。後続のページリクエストは、レート制限上の新たなクエリとしてカウントされません。

​
キャッシュ

レスポンスには ETag ヘッダーが含まれます。不要なデータ転送を避けるには、前回の ETag の値を If-None-Match ヘッダーに含めてください。データが変更されていない場合、サーバーは 304 Not Modified を返します。

​
レート制限

このエンドポイントには、チームごとに1時間あたり10リクエストのレート制限があります。この制限を超えると、 サーバーは Retry-After ヘッダーとともに 429 Too Many Requests を返します。 以前のクエリのページネーション (next_page_cursor をたどる場合) は、この制限にカウントされません — 対象となるのは、各レポートの初回クエリのみです。制限が低く設定されているのは、このエンドポイントが リアルタイムの使用量監視ではなく、定期的なレポート作成を目的としているためです。

承認

​
Authorization
string
header
必須

Authorization ヘッダーで Bearer トークンとして渡す、Analytics Read 権限を持つサービスキー。

サービスキーは、チーム設定 の「Service Keys」セクションで作成します。

ヘッダー

​
If-None-Match
string

前回のレスポンスの ETag 値。データが変更されていない場合、server は 304 Not Modified を返します。

クエリパラメータ

​
start_date
string<date>
必須

日付範囲の開始日（この日を含む）。形式は YYYY-MM-DD です。

​
end_date
string<date>
必須

日付範囲の終了日（この日を含む）。形式は YYYY-MM-DD です。範囲は 90 日を超えてはいけません。

​
product
enum<string>
必須

アクティブユーザーをクエリする対象の product。

利用可能なオプション:
agent
​
granularity
enum<string>

結果をグループ化する時間粒度。指定した場合、各行に timestamp フィールドが含まれます。 省略した場合、アクティブユーザー数は日付範囲全体で集計されます。

利用可能なオプション:
daily,
monthly
​
group_by
enum<string>

結果をグループ化するディメンション。アクティブユーザー endpoint でサポートされているのは user のみで、この場合は アクティブユーザーごとに 1 行（各行の active_users = 1）が返されます。

利用可能なオプション:
user
​
models
string

結果の絞り込みに使用する model UID のカンマ区切りリスト。

​
group_id
string

結果を特定の group に属するユーザーに絞り込みます。サービスキーにはこの group へのアクセス権が必要です。

​
user_id
string

結果を特定のユーザー（auth UID）に絞り込みます。

​
page_size
integer
デフォルト:1000

1 ページあたりに返される行数の上限。

必須範囲: 1 <= x <= 10000
​
page_cursor
string

次のページを取得するための、前回のレスポンスの pagination.next_page_cursor に含まれる不透明なカーソル。

レスポンス

アクティブユーザーデータが正常に返されました。

​
data
object[]
必須

アクティブユーザーデータ行の配列。

​
pagination
object
必須
​
metadata
object
必須