Account Usage

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

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.

GEThttps://api.enzoic.com/v1/account-usage

Authorization

enzoic_auth

Query parameters

Response

200

The response contains requested usage statistics.

Body

application/json

apiCallUsageinteger

The total number of API calls made on your account

Example: 443644

passwordAPICallsinteger

The number of Passwords API calls made during the specified billing period

Example: 438364

passwordAPIMatchesinteger

The number of matches returned by the Passwords API during the specified billing period. This can be used as a rough estimate for what percentage of the time a password was rejected.

Example: 344697

credentialsAPICallsinteger

The number of Credentials API checks made during the specified billing period

Example: 120831

credentialsAPIMatchesinteger

The number of matches returned by the Credentials API during the specified billing period. This can be used as a rough estimate for what percentage of the time a set of credentials was found to be compromised.

Example: 10219

exposuresAPICallsinteger

The number of Exposures API calls made during the specified billing period

Example: 23099

exposuresAPIMatchesinteger

The number of matches returned by the Exposures API during the specified billing period.

Example: 17833

Request

JavaScriptCurlPython

const response = await fetch('https://api.enzoic.com/v1/account-usage', {
    method: 'GET',
    headers: {
      "Authorization": "basic <token>"
    },
});
const data = await response.json();

Response

200

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