Custom Integrations - Retrieving Email Statistics Documentation

This API allows you to retrieve a list of a user's recent email verification API usage, based on the Email Validation service. This API supports both HTML (table) and JSON responses to allow you to choose how to display results.

Calling Email Statistics

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

https://www.ipqualityscore.com/webhooks/ExampleIntegration/json/email_statistics

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

https://www.ipqualityscore.com/webhooks/ExampleIntegration/html/email_statistics

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: Email Verification API Stats

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

email_lookups

The total number of recent email API requests by this user.

int

email_fraud_detections

The total number of recent email API requests that were fraudulent.

int

email_detection_ratio

The ratio of email API requests that were clean/fraudulent.

float, percentage

remaining_credits

The total number of credits currently available to this user.

int

recent_lookups

List containing the 1,000 most recent email validation lookups by this user.

Parameter	Description	Example Value / Format
email_address	The email address that the user requested fraud information on.	string, email address
disposable	Was the email address disposable?	boolean
valid	The validity of the email address.	boolean
deliverability	How deliverable was the email address?	low, medium, high
date	The date this request was made on.	date formatted Y-m-d H:i:is

Array of objects

Example Code


// URL for this request.
$URL = 'https://www.ipqualityscore.com/webhooks/ExampleIntegration/json/email_statistics';

// Configuration items for this request. NOTE: $secret will be user specific not application specific.
$key = 'example.com';
$secret = 'WkYwHzjeWMqGBuJKBA98Ko63arm3Cd6n3gwfucxaldFPyflJQ4X4oYmaHZmEudy7RGzF3v7I8GCVvaPpCBbsJD17XdGWYSunc8dmpvbxkH6QlcT5SxuH2pmt2Dhu4cDM';

// 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.";
}