reporting

Lists API key counts for the account.

This endpoint lists the API key counts of the account, providing an overview of API access usage and distribution for improved visibility and reporting.</br></br>Key features include:</br></br>- Clear success messaging: Returns a 200 success code with a confirmation message indicating the successful completion of the requested action.</br>- Comprehensive data retrieval: Returns a comprehensive list of API key counts, providing a complete and accurate overview for reporting purposes.</br>- Comprehensive error handling: Returns a 401 error code with a clear description when requests fail.

get/reporting/api-keys

Request

Response

API key counts listed successfully.

serviceKeyCountinteger

Number of service API keys in the account

userKeyCountinteger

Number of user API keys in the account

totalKeyCountinteger

Total number of API keys in the account

activeKeyCountinteger

Number of active API keys in the account

disabledKeyCountinteger

Number of disabled API keys in the account

expiredKeyCountinteger

Number of expired API keys in the account

expiring30DayCountinteger

Number of API keys expiring in the next 30 days

expiring7DayCountinteger

Number of API keys expiring in the next 7 days

Example response

[
  {
    "serviceKeyCount": 1,
    "userKeyCount": 2,
    "totalKeyCount": 3,
    "activeKeyCount": 1
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.