メインコンテンツへスキップ
GET
アクティブユーザー分析を取得
これは、リクエストボディで サービスキー を使用する v1 Analytics API とは異なり、Bearer トークン認証とクエリパラメータを使用する v2 エンドポイントです。詳しくは以下の認証を参照してください。
このエンドポイントは、リアルタイムでの使用量監視を目的としたものではありません。データは1時間単位で集計され、 レート制限も厳しく設定されています (チームごとに1時間あたり10リクエスト) 。定期的なレポートや一括エクスポートに利用してください。

認証

このエンドポイントでは、Bearer トークン認証を使用します。Authorization ヘッダーにトークンを含めてください。
Use Local Analytics API 権限を持つDevinサービスユーザーAPIキー、または Analytics Read 権限を持つWindsurf サービスキーを使用します。各キーの作成方法については、 Authenticationを参照してください。

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

ある時間バケット内に課金イベントが1件でもある場合、そのユーザーはその時間バケットにおいてアクティブとしてカウントされます。active_users フィールドには、重複のないユーザー数が記録されます。
アクティブユーザー数には、Devin CLI と Devin Desktop の両方の使用量が含まれます。いずれか一方 (または両方) でアクティブなユーザーはカウントされ、時間バケットごとに1回だけ計上されます。

グループ化と時間粒度

返されるデータの形式を制御するには、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、os) はここでは無効です。

ページネーション

結果は、デフォルトで 1,000 件 (最大 10,000 件) ずつページ分けされます。さらに結果がある場合、 レスポンスの pagination オブジェクトに next_page_cursor が含まれます。これを page_cursor クエリ パラメータとして渡すと、次のページを取得できます。 ページカーソルは 24 時間で期限切れになります。後続のページリクエストは、レート制限上の新たなクエリとしてカウントされません。

レート制限

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

承認

Authorization
string
header
必須

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

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

クエリパラメータ

start_date
string<date>
必須

日付範囲の開始日(当日を含む)。YYYY-MM-DD形式で指定します。

end_date
string<date>
必須

日付範囲の終了日(当日を含む)。YYYY-MM-DD形式で指定します。範囲は90日以内にする必要があります。

product
enum<string>
必須

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

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

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

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

結果のグループ化に使用するディメンション。アクティブユーザーのエンドポイントはuserのみに対応し、 アクティブユーザーごとに1行を返します(各行でactive_users = 1)。

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

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

group_id
string

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

user_id
string

結果を特定のユーザー(認証UID)に絞り込みます。

page_size
integer
デフォルト:1000

1ページあたりに返す行数の上限。

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

次のページの取得に使用する不透明なカーソル。前の応答のpagination.next_page_cursorの値を指定します。

レスポンス

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

data
object[]
必須

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

pagination
object
必須
metadata
object
必須