這個 API 為第一版。我們會根據回饋持續擴充功能—告訴我們你需要哪些 endpoints!
驗證
建立 API 金鑰
- 前往 cursor.com/dashboard → Settings 分頁 → Cursor Admin API Keys
- 點選 Create New API Key
- 幫你的金鑰取個易懂的名稱(例如:「Usage Dashboard Integration」)
- 立刻複製產生的金鑰,之後就看不到了
key_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
使用你的 API 金鑰
基底 URL
端點(Endpoints)
取得團隊成員
回應
範例回應
範例請求
取得每日使用資料
請求本文
參數 | 類型 | 必填 | 說明 |
---|---|---|---|
startDate | number | 是 | 以 epoch 毫秒表示的開始日期 |
endDate | number | 是 | 以 epoch 毫秒表示的結束日期 |
日期區間不可超過 90 天。更長的期間請分多次發送請求。
回應
回應欄位
欄位 | 說明 |
---|---|
date | 以 epoch 毫秒表示的日期 |
isActive | 使用者在該日是否為活躍狀態 |
totalLinesAdded | 新增的程式碼行數 |
totalLinesDeleted | 刪除的程式碼行數 |
acceptedLinesAdded | 由已接受的 AI 建議新增的行數 |
acceptedLinesDeleted | 由已接受的 AI 建議刪除的行數 |
totalApplies | 套用(apply)操作次數 |
totalAccepts | 接受的建議數 |
totalRejects | 拒絕的建議數 |
totalTabsShown | 顯示的 Tab 自動補全次數 |
totalTabsAccepted | 接受的 Tab 自動補全次數 |
composerRequests | Composer 請求數 |
chatRequests | Chat 請求數 |
agentRequests | Agent 請求數 |
cmdkUsages | 指令面板(Cmd+K)使用次數 |
subscriptionIncludedReqs | 訂閱內含請求數 |
apiKeyReqs | API 金鑰請求數 |
usageBasedReqs | 依用量付費請求數 |
bugbotUsages | Bug 偵測使用次數 |
mostUsedModel | 最常使用的 AI 模型 |
applyMostUsedExtension | apply 最常使用的檔案副檔名 |
tabMostUsedExtension | tab 最常使用的檔案副檔名 |
clientVersion | Cursor 版本 |
email | 使用者 Email |
範例回應
範例請求
取得支出資料
Request Body
參數 | 型別 | 必填 | 說明 |
---|---|---|---|
searchTerm | string | 否 | 在使用者名稱與電子郵件中搜尋 |
sortBy | string | 否 | 依以下欄位排序:amount 、date 、user 。預設值:date |
sortDirection | string | 否 | 排序方向:asc 、desc 。預設值:desc |
page | number | 否 | 頁碼(從 1 開始)。預設值:1 |
pageSize | number | 否 | 每頁結果數 |
回應
回應次位
欄位 | 說明 |
---|---|
spendCents | 總支出(單位:美分) |
fastPremiumRequests | Fast Premium 模型請求數 |
name | 成員姓名 |
email | 成員的 Email |
role | 團隊角色 |
hardLimitOverrideDollars | 自訂支出上限覆寫值(美元) |
subscriptionCycleStart | 訂閱週期開始時間(epoch 毫秒) |
totalMembers | 團隊成員總數 |
totalPages | 總頁數 |
範例回應
範例請求
取得使用事件資料
Request Body
Parameter | Type | Required | Description |
---|---|---|---|
startDate | number | No | 以 epoch 毫秒表示的開始日期 |
endDate | number | No | 以 epoch 毫秒表示的結束日期 |
userId | number | No | 依特定使用者 ID 篩選 |
page | number | No | 頁碼(從 1 起算)。預設值:1 |
pageSize | number | No | 每頁結果數量。預設值:10 |
email | string | No | 依使用者電子郵件地址篩選 |
回應
回應欄位說明
欄位 | 說明 |
---|---|
totalUsageEventsCount | 與查詢條件相符的使用事件總數 |
pagination | 用於瀏覽結果的分頁中繼資料 |
timestamp | 事件的 Unix 紀元毫秒時間戳 |
model | 此請求所使用的 AI 模型 |
kind | 使用類別(例如:「Usage-based」、「Included in Business」) |
maxMode | 是否啟用 Max Mode |
requestsCosts | 以請求單位計算的成本 |
isTokenBasedCall | 若事件以用量計費,則為 true |
tokenUsage | 詳細的權杖使用量(當 isTokenBasedCall 為 true 時提供) |
isFreeBugbot | 是否為免費的 Bugbot 使用 |
userEmail | 發出請求的使用者電子郵件地址 |
period | 查詢資料的日期範圍 |
範例回應
範例請求
設定使用者支出上限
速率限制: 每個團隊每分鐘 60 次請求
請求本文
參數 | 類型 | 必填 | 說明 |
---|---|---|---|
userEmail | string | Yes | 團隊成員的電子郵件地址 |
spendLimitDollars | number | Yes | 以美元計的支出上限(僅限整數,不含小數)。 |
- 使用者必須已經是你團隊的成員
- 只接受整數值(不含小數金額)
- 將
spendLimitDollars
設為 0 會把上限設為 $0
回應
範例回應
範例請求
Repo Blocklists API
取得團隊 Repo 封鎖清單
回應
範例回應
範例請求
以 Upsert 方式更新 Repo 封鎖清單
Request Body
參數 | 類型 | 必填 | 說明 |
---|---|---|---|
repos | array | 是 | 儲存庫黑名單物件的陣列 |
欄位 | 類型 | 必填 | 說明 |
---|---|---|---|
url | string | 是 | 要加入黑名單的儲存庫 URL |
patterns | string[] | 是 | 要封鎖的檔案樣式陣列(支援 glob 模式) |
回應
範例請求
刪除 Repo 封鎖清單
參數
參數 | 類型 | 必填 | 說明 |
---|---|---|---|
repoId | string | 是 | 要刪除的儲存庫封鎖名單 ID |
回應
範例請求
範例模式
*
- 封鎖整個儲存庫*.env
- 封鎖所有 .env 檔案config/*
- 封鎖 config 目錄下的所有檔案**/*.secret
- 封鎖任意子目錄中的所有 .secret 檔案src/api/keys.ts
- 封鎖特定檔案