この API は初回リリース。フィードバックに基づいて機能を拡張中—必要なエンドポイントを教えてね!
認証
APIキーの作成
- cursor.com/dashboard → Settings タブ → Cursor Admin API Keys に移動
- Create New API Key をクリック
- キーにわかりやすい名前を付ける(例:「Usage Dashboard Integration」)
- 生成されたキーはその場でコピーしておく—あとからは確認できない
key_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
APIキーの使用
ベースURL
エンドポイント
チームメンバーの取得
レスポンス
応答例
例: リクエスト
日次利用データを取得
リクエストボディ
パラメーター | 型 | 必須 | 説明 |
---|---|---|---|
startDate | number | Yes | エポックミリ秒の開始日時 |
endDate | number | Yes | エポックミリ秒の終了日時 |
日付範囲は90日を超えない。より長い期間は複数回に分けてリクエストしてね。
応答
レスポンスフィールド
フィールド | 説明 |
---|---|
date | エポックミリ秒の日時 |
isActive | 当日のユーザーアクティブ状態 |
totalLinesAdded | 追加されたコード行数 |
totalLinesDeleted | 削除されたコード行数 |
acceptedLinesAdded | 承認されたAI提案による追加行数 |
acceptedLinesDeleted | 承認されたAI提案による削除行数 |
totalApplies | Applyの実行回数 |
totalAccepts | 承認された提案数 |
totalRejects | 却下された提案数 |
totalTabsShown | 表示されたタブ補完数 |
totalTabsAccepted | 承認されたタブ補完数 |
composerRequests | Composerリクエスト数 |
chatRequests | Chatリクエスト数 |
agentRequests | Agentリクエスト数 |
cmdkUsages | コマンドパレット(Cmd+K)の使用回数 |
subscriptionIncludedReqs | サブスクリプション対象のリクエスト数 |
apiKeyReqs | APIキー経由のリクエスト数 |
usageBasedReqs | 従量課金リクエスト数 |
bugbotUsages | バグ検出機能の使用回数 |
mostUsedModel | 最も頻繁に使用されたAIモデル |
applyMostUsedExtension | Applyで最も使用されたファイル拡張子 |
tabMostUsedExtension | タブで最も使用されたファイル拡張子 |
clientVersion | Cursorのバージョン |
email | ユーザーのメールアドレス |
例のレスポンス
リクエストの例
支出データを取得
リクエストボディ
パラメータ | 型 | 必須 | 説明 |
---|---|---|---|
searchTerm | string | いいえ | ユーザー名とメールアドレス内を検索 |
sortBy | string | いいえ | 並び替え基準: amount , date , user 。既定値: date |
sortDirection | string | いいえ | 並び順: asc , desc 。既定値: desc |
page | number | いいえ | ページ番号(1始まり)。既定値: 1 |
pageSize | number | いいえ | 1ページあたりの件数 |
レスポンス
レスポンスフィールド
フィールド | 説明 |
---|---|
spendCents | 合計支出(セント) |
fastPremiumRequests | Fast プレミアムモデルのリクエスト数 |
name | メンバー名 |
email | メンバーのメールアドレス |
role | チーム内ロール |
hardLimitOverrideDollars | カスタム支出上限の上書き(ドル) |
subscriptionCycleStart | サブスクリプションサイクル開始時刻(エポックミリ秒) |
totalMembers | チームメンバー総数 |
totalPages | 総ページ数 |
応答例
リクエスト例
使用イベントデータの取得
リクエストボディ
パラメータ | 型 | 必須 | 説明 |
---|---|---|---|
startDate | number | いいえ | エポックミリ秒の開始日時 |
endDate | number | いいえ | エポックミリ秒の終了日時 |
userId | number | いいえ | 特定のユーザーIDでフィルタリング |
page | number | いいえ | ページ番号(1始まり)。既定値: 1 |
pageSize | number | いいえ | 1ページあたりの結果数。既定値: 10 |
email | string | いいえ | ユーザーのメールアドレスでフィルタリング |
応答
レスポンスフィールドの説明
フィールド | 説明 |
---|---|
totalUsageEventsCount | クエリに一致する利用イベントの総数 |
pagination | 結果を移動するためのページネーション用メタデータ |
timestamp | イベントのエポックミリ秒でのタイムスタンプ |
model | リクエストで使用された AI モデル |
kind | 利用区分(例: “Usage-based”, “Included in Business”) |
maxMode | Max Mode が有効だったかどうか |
requestsCosts | リクエスト単位のコスト |
isTokenBasedCall | イベントが従量課金として計上される場合は true |
tokenUsage | トークン消費の詳細(isTokenBasedCall が true の場合に提供) |
isFreeBugbot | 無料の Bugbot 利用かどうか |
userEmail | リクエスト実行ユーザーのメールアドレス |
period | クエリ対象データの期間(日時範囲) |
応答例
リクエスト例
ユーザーの支出上限を設定
レート制限: チームあたり毎分60リクエスト
リクエストボディ
パラメータ | 型 | 必須 | 説明 |
---|---|---|---|
userEmail | string | はい | チームメンバーのメールアドレス |
spendLimitDollars | number | はい | 支出上限(米ドル、整数のみ。小数不可) |
- ユーザーはすでにチームのメンバーである必要がある
- 受け付けるのは整数値のみ(小数は不可)
spendLimitDollars
を 0 に設定すると、上限は $0 になる
Response
レスポンス例
リクエスト例
Repo Blocklists API
チームのリポジトリ・ブロックリストを取得
レスポンス
レスポンスの例
リクエストの例
リポジトリブロックリストのアップサート
リクエストボディ
Parameter | Type | Required | Description |
---|---|---|---|
repos | array | Yes | リポジトリのブロックリスト対象オブジェクトの配列 |
Field | Type | Required | Description |
---|---|---|---|
url | string | Yes | ブロックリスト対象のリポジトリのURL |
patterns | string[] | Yes | ブロックするファイルパターンの配列(glob パターン対応) |
レスポンス
例: リクエスト
リポジトリブロックリストの削除
パラメータ
パラメータ | 型 | 必須 | 説明 |
---|---|---|---|
repoId | string | はい | 削除対象のリポジトリブロックリストのID |
レスポンス
リクエストの例
パターン例
*
- リポジトリ全体をブロック*.env
- すべての.envファイルをブロックconfig/*
- configディレクトリ内のすべてのファイルをブロック**/*.secret
- 任意のサブディレクトリ内のすべての.secretファイルをブロックsrc/api/keys.ts
- 特定のファイルをブロック