Skip to navigation
Account

Get Account Metrics

View as Markdown
Returns usage metrics for the authenticated account in the simplified v6.0 format. In v6.0 all keys are geo keys, so the counters reflect geo usage.

Authentication

X-API-KEYstring
API Key authentication via header

Query parameters

keystringOptional10-100 characters

API key identifying the account whose usage metrics are returned. May be supplied as this query parameter or the X-API-KEY header.

Response

OK
is_activeboolean
Whether the account is currently active.
messagestring
Informational message about the account.
request_countlong
Number of requests consumed in the current period.
request_limitlong
Maximum requests allowed for the account in the current period.
usage_percentdouble

Request usage as a percentage of the limit (0-100).

Errors

400
Get Account Metrics V60request Bad Request Error
422
Get Account Metrics V60request Unprocessable Entity Error
500
Get Account Metrics V60request Internal Server Error