API Guide

Get Campaign ISP Detail

The Campaign ISP Detail data set provides detailed mailbox performance for eiter one specific ISP or all ISPs, and campaign. Data is returned in the following formats: XML, JSON, CSV and Serialized.

Required headers: X-API-KEY
Optional headers: ACCEPT (json, xml, csv, serialized)
Method: GET

Endpoint URL:


Sample Output:

        "provider": "Gmail",
        "recipient": "someaddress@gmail.com",
        "location": "inbox",
        "tab": "primary",
        "email_id": "2222222",
        "dkim": "pass",
        "spf": "pass",
        "senderip": "",
        "receiveddate": "2015-04-03 06:00:25"
        "provider": "AOL",
        "recipient": "anotheraddress@aol.com",
        "location": "inbox",
        "tab": null,
        "email_id": "1111111",
        "dkim": "pass",
        "spf": "pass",
        "senderip": "",
        "receiveddate": "2015-04-03 06:00:28"


Parameter Description Acceptable Values Required
id The unique identifier of the campaign Integer Y
xheader The unique x-header value assigned to the campaign (see 'xheader' key in sample response from Campaign Summary). String Y*
provider Specifies which ISP detail to retrieve. String, example: AOL N
* Either 'xheader' or 'id' can be passed. Both are not required.

Error Responses

Description Code Cause
Invalid campaign ID. 404 The unique identifier of the campaign is invalid
Invalid provider string. 404 The ISP specified is invalid
Invalid X-Header. 404 We couldn't find any campaigns using your X-Header
No results found. 404 We couldn't find any results matching your criteria.