Developers
Account

Retrieve account usage

GET/account/usage

Returns aggregated API usage for the account over the time window selected by period, including request and operation totals, a breakdown by credential, and rate limit information.

Figures are computed from live data when the request is made, so ingestion_delay_seconds is always 0, and the response is never cached.

Requires the usage.read permission.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

period*string

Value in

  • "1h"
  • "24h"
  • "7d"
  • "30d"

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/account/usage?period=1h"
{  "data": {    "by_credential": [      {        "credential_id": "string",        "operations": 0,        "requests": 0      }    ],    "ingestion_delay_seconds": 0,    "object": "usage",    "operations": {      "by_status": {},      "total": 0    },    "rate_limits": {      "credential": {        "ops_per_minute": 0      },      "instance": {        "ops_per_minute": 0      }    },    "requests": {      "by_outcome": {},      "total": 0    },    "window": {      "from": "2019-08-24T14:15:22Z",      "to": "2019-08-24T14:15:22Z"    }  }}

Retrieve the account GET

Returns a read-only overview of the account associated with the current credentials: identity, student quota, billing status, and replica and sandbox relationships. Billing information does not include amounts, plan details, or payment methods. Requires the `account.read` permission.

Domains

Next Page