Account Usage

Returns extended API usage stats for your account for the specified month and year, including efficacy reporting.

get

Returns extended API usage stats for your account for the specified month and year, including efficacy reporting. Note that current usage numbers may be up to 5 minutes behind.

Authorizations

enzoic_auth

AuthorizationstringRequired

The Enzoic API uses a basic auth scheme where the username is your API key and the password is your API secret.
See https://docs.enzoic.com/enzoic-api-developer-documentation/using-the-enzoic-api#api-authentication for more details.

Query parameters

monthintegerOptional

(Optional) The numeric month you wish to retrieve data for (1-12). Defaults to the current month.

Default: <current month>Example: 10

yearintegerOptional

(Optional) The full year you wish to retrieve data for (e.g. 2023). Defaults to the current year.

Default: <current year>Example: 2023

Responses

200

The response contains requested usage statistics.

application/json

get

/account-usage

HTTPcURLJavaScriptPython

GET /v1/account-usage HTTP/1.1
Host: api.enzoic.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

The response contains requested usage statistics.

{
  "apiCallUsage": 443644,
  "passwordAPICalls": 438364,
  "passwordAPIMatches": 344697,
  "credentialsAPICalls": 120831,
  "credentialsAPIMatches": 10219,
  "exposuresAPICalls": 23099,
  "exposuresAPIMatches": 17833
}