Custom Integrations - Retrieving Overview Statistics Documentation


This API allows you to retrieve statistics about a user's API usage. This API supports both HTML (table) and JSON responses to allow you to choose how to display results.

Calling Overview Statistics

If you would like a JSON response from this API you can call:

https://ipqualityscore.com/webhooks/ExampleIntegration/json/overview

If you would like a HTML response from this API you can call:

https://ipqualityscore.com/webhooks/ExampleIntegration/html/overview

Request Parameters
Parameter Description Example Value / Format
key Your site's domain or the domain that requested this integration. REQUIRED google.com
secret Your user's current secret created during the authentication process. REQUIRED char(128)

Result

The HTML response will look like the screenshot below:
The JSON response will have the following data points:
Parameter Description Example Value / Format
message Description of the status of this call. May contain errors if errors exist. text
success Boolean result of if the request was successful or not. boolean
recent_api_usage The total number of recent API requests by this user. int
recent_proxy_lookups The total number of recent proxy API requests by this user. int
recent_email_lookups The total number of recent email API requests by this user. int
recent_tracker_lookups The total number of recent tracker API requests by this user. int
Example Code