Access team metrics, usage data, and spending information via API
key_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Parameter | Type | Required | Description |
---|---|---|---|
startDate | number | Yes | Start date in epoch milliseconds |
endDate | number | Yes | End date in epoch milliseconds |
Field | Description |
---|---|
date | Date in epoch milliseconds |
isActive | User active on this day |
totalLinesAdded | Lines of code added |
totalLinesDeleted | Lines of code deleted |
acceptedLinesAdded | Lines added from accepted AI suggestions |
acceptedLinesDeleted | Lines deleted from accepted AI suggestions |
totalApplies | Apply operations |
totalAccepts | Accepted suggestions |
totalRejects | Rejected suggestions |
totalTabsShown | Tab completions shown |
totalTabsAccepted | Tab completions accepted |
composerRequests | Composer requests |
chatRequests | Chat requests |
agentRequests | Agent requests |
cmdkUsages | Command palette (Cmd+K) uses |
subscriptionIncludedReqs | Subscription requests |
apiKeyReqs | API key requests |
usageBasedReqs | Pay-per-use requests |
bugbotUsages | Bug detection uses |
mostUsedModel | Most frequent AI model |
applyMostUsedExtension | Most used file extension for applies |
tabMostUsedExtension | Most used file extension for tabs |
clientVersion | Cursor version |
email | User email |
Parameter | Type | Required | Description |
---|---|---|---|
searchTerm | string | No | Search in user names and emails |
sortBy | string | No | Sort by: amount , date , user . Default: date |
sortDirection | string | No | Sort direction: asc , desc . Default: desc |
page | number | No | Page number (1-indexed). Default: 1 |
pageSize | number | No | Results per page |
Field | Description |
---|---|
spendCents | Total spend in cents |
fastPremiumRequests | Fast premium model requests |
name | Member’s name |
email | Member’s email |
role | Team role |
hardLimitOverrideDollars | Custom spending limit override |
subscriptionCycleStart | Subscription cycle start (epoch milliseconds) |
totalMembers | Total team members |
totalPages | Total pages |
Parameter | Type | Required | Description |
---|---|---|---|
startDate | number | No | Start date in epoch milliseconds |
endDate | number | No | End date in epoch milliseconds |
userId | number | No | Filter by specific user ID |
page | number | No | Page number (1-indexed). Default: 1 |
pageSize | number | No | Number of results per page. Default: 10 |
email | string | No | Filter by user email address |
Field | Description |
---|---|
totalUsageEventsCount | Total number of usage events matching the query |
pagination | Pagination metadata for navigating results |
timestamp | Event timestamp in epoch milliseconds |
model | AI model used for the request |
kindLabel | Usage category (e.g., “Usage-based”, “Included in Business”) |
maxMode | Whether max mode was enabled |
requestsCosts | Cost in request units |
isTokenBasedCall | True when the event is charged as a usage-based event |
tokenUsage | Detailed token consumption (available when isTokenBasedCall is true) |
isFreeBugbot | Whether this was a free bugbot usage |
userEmail | Email of the user who made the request |
period | Date range of the queried data |
Parameter | Type | Required | Description |
---|---|---|---|
repos | array | Yes | Array of repository blocklist objects |
Field | Type | Required | Description |
---|---|---|---|
url | string | Yes | Repository URL to blocklist |
patterns | string[] | Yes | Array of file patterns to block (glob patterns supported) |
Parameter | Type | Required | Description |
---|---|---|---|
repoId | string | Yes | ID of the repository blocklist to delete |
*
- Block entire repository*.env
- Block all .env filesconfig/*
- Block all files in config directory**/*.secret
- Block all .secret files in any subdirectorysrc/api/keys.ts
- Block specific file