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.
- Proxy & VPN Detection API
- Email Verification API
- Phone Number Validation API
- Device Fingerprint API
- Malicious URL Scanner 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 API
- Allowlist & Blocklist APIs
- Plugins Platforms & Integrations
- IP Reputation Database
- Email Verification Database
- Custom Integrations
- Country List API
Overview Statistics
About Overview Statistics in Custom Integrations
API Request URLs
JSON
You can use the following URL to retrieve statistics in JSON format:
HTML
Alternatively, you can use the following URL to retrieve statistics in HTML format:
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:
EXAMPLE CODE
xxxxxxxxxx
1
// URL for this request.
2
$URL = 'https://www.ipqualityscore.com/webhooks/ExampleIntegration/json/overview';
3
4
// Configuration items for this request. NOTE: $secret will be user specific not application specific.
5
$key = 'example.com';
6
$secret = 'YOUR_API_KEY_HERE';
7
8
// Prepare POST fields.
9
$fields = array(
10
'secret' => $secret,
11
'key' => $key
12
);
13
14
// Create CURL.
15
$curl = curl_init();
16
17
// Configure CURL
18
curl_setopt($curl, CURLOPT_URL, $URL);
19
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
20
curl_setopt($curl, CURLOPT_FOLLOWLOCATION, true);
21
curl_setopt($curl, CURLOPT_POST, 1);
22
23
// Set POST Parameters
24
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($fields));
25
26
// Fetch URL
27
$result = curl_exec($curl);
28
29
// GET response code.
30
$response_code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
31
32
// Close CURL
33
curl_close($curl);
34
35
// Handle result.
36
if((int) $response_code === 200){
37
// JSON Decode
38
$output = json_decode($result, true);
39
40
// Use statistics.
41
} else {
42
echo "There appears to be an unforeseen error. Please contact IPQualityScore support if this persists.";
43
}