- About the IPQS APIs
- Proxy & VPN Detection API
- Email Verification API
- Phone Number Validation API
- Malicious URL Scanner API
- Device Fingerprint API
- Mobile Device Fingerprinting SDK
- Gaming Fraud Detection SDK
- Dark Web Leak API
- Malware File Scanner API
- Request List API
- Fraud Reporting API
- Account Management APIs
- Bulk Validation CSV
- Allowlist Blocklist APIs
- Plugins Platforms Integrations
- IP Reputation Database
- IP Address Abuse Feed
- Email Verification Database
-
Custom Integrations
- Getting Started
- Authentication
- Refresh Secret
- IP & Proxy Checks
- Email Verification Checks
- Phone Number Validity Checks
- Device Tracker
- List Device Trackers
- Device Tracker Statistics
- Login Tokens
- Overview Statistics
- Recent Proxy Statistics
- Recent Email Statistics
- Fraud Reporting
- Retrieve Requests by ID
- Country List API Documentation
- Release Notes
Overview Statistics
Rate this article:
Select all that apply:
Email:
About Overview Statistics in Custom Integrations
This API allows you to retrieve overall statistics about a user's API usage. It supports both JSON and HTML (table) responses, allowing you to choose how to display results.
API Request URLs
JSON
You can use the following URL to retrieve statistics in JSON format:
https://www.ipqualityscore.com/webhooks/ExampleIntegration/json/overview
HTML
Alternatively, you can use the following URL to retrieve statistics in HTML format:
https://www.ipqualityscore.com/webhooks/ExampleIntegration/html/overview
Request Parameters
| Parameter | Description | Example Value / Format |
|---|---|---|
| key | Required. Your site's domain or the domain that requested this integration. | google.com |
| secret | Required. Your user's current secret created during the authentication process. | char(128) |
Response Parameters
JSON
The JSON response will have the following data points:
| Parameter | Description | 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 |
HTML
The HTML Response will look like the screenshot below:

// URL for this request.
$URL = 'https://www.ipqualityscore.com/webhooks/ExampleIntegration/json/overview';
// Configuration items for this request. NOTE: $secret will be user specific not application specific.
$key = 'example.com';
$secret = 'YOUR_API_KEY_HERE';
// Prepare POST fields.
$fields = array(
'secret' => $secret,
'key' => $key
);
// Create CURL.
$curl = curl_init();
// Configure CURL
curl_setopt($curl, CURLOPT_URL, $URL);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($curl, CURLOPT_POST, 1);
// Set POST Parameters
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($fields));
// Fetch URL
$result = curl_exec($curl);
// GET response code.
$response_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
// Close CURL
curl_close($curl);
// Handle result.
if((int) $response_code === 200){
// JSON Decode
$output = json_decode($result, true);
// Use statistics.
} else {
echo "There appears to be an unforeseen error. Please contact IPQualityScore support if this persists.";
}