Account

account

The credential making the request, its scopes and its credit balance.

objectstring: The object's type. Always credential.
organizationstring: The organization's id.
organization_namestring: The organization's name.
planstring: The organization's plan, such as free.
kindstring: Whether the credential belongs to a person or a machine. One of user or machine.
subjectstring: The id of the API key, user or OAuth client the credential belongs to.
methodstring: How the request was authenticated. One of session, api_key, oauth or mcp.
namestring: The API key's name or the user's email address, for display.
scopearray of strings: The credential's scopes, such as record:read and webhook:manage. A console session also has its role's *:manage scopes.
credit_balanceinteger: The current credit balance.
userstring: The user's id. Null for a machine credential.

Requests, credits spent and the credit balance.

objectstring

The object's type. Always usage_summary.

organization_idstring

The organization's id.

sincetimestamp

The start of the period.

untiltimestamp

The end of the period: the time of the request.

requestsinteger

Requests made in the period.

credits_spentinteger

Credits spent in the period.

free_requestsinteger

Successful requests that cost no credits: free endpoints, repeat requests within a day, empty results and reads in Explorer.

credit_balanceinteger

The current credit balance.

included_creditsinteger

Credits included with the plan each billing period. 0 without a plan.

dailyarray of objects

Requests and credits by day, oldest first.

Show fields

by_endpointarray of objects

Requests and credits by endpoint, most credits first. At most 20.

Show fields

namestring: The endpoint, such as /v1/parcel, or the API key's name. Console, MCP or OAuth for requests made without an API key.
requestsinteger: Requests made.
creditsinteger: Credits spent.

by_keyarray of objects

Requests and credits by API key, most credits first. At most 20. Requests made without a key are grouped as Console, MCP or OAuth.

Show fields

namestring: The endpoint, such as /v1/parcel, or the API key's name. Console, MCP or OAuth for requests made without an API key.
requestsinteger: Requests made.
creditsinteger: Credits spent.