API Guide

Get Campaign Summary

The Get Summary API call provides a broad view of campaign performance. 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:

https://api.250ok.com/api/1.0/inboxinformant/summary

Sample Output:

[
    {
        "id": "30378",
        "date": "06/06/2014",
        "timestamp": "2014-06-06 12:00:00",
        "subject": "Daily e-mail / system test: 1402079769.06",
        "xheader": "1402394401.34",
        "from": "alerts@alerts.250ok.net",
        "inbox": 372,
        "spam": 22,
        "missing": 0,
        "inboxpct": 93.7,
        "spampct": 5.5,
        "missingpct": 0.8,
        "spf": 85.8,
        "dkim": 92.2,
        "status": "In Progress"
    },
    {
        "id": "30252",
        "date": "06/04/2014",
        "timestamp": "2014-06-06 11:00:00",
        "subject": "Daily e-mail / system test: 1401876001.33",
        "xheader": "1402394401.34",
        "from": "alerts@alerts.250ok.net",
        "inbox": 375,
        "spam": 22,
        "missing": 0,
        "inboxpct": 94.5,
        "spampct": 5.5,
        "missingpct": 0,
        "spf": 85.8,
        "dkim": 92.2
        "status": "Complete"
    }
]
        

Parameters

Parameter Description Acceptable Values Required
id Unique identifier of the campaign. Integer N
xheader Unique X-250ok-CID header sent with the campaign. String N
startdate Returns campaigns executed after the specified date. yyyy-mm-dd N
enddate Returns campaigns executed before the specified date. yyyy-mm-dd N
from Return campaigns that have the specified value in the campaign ‘from’ e-mail address. String N
subject Return campaigns that have the specified value in the campaign subject. String N
spfdomain Return campaigns that have the specified value in the SPF record. String N
dkimdomain Return campaigns that have the specified value in the DKIM Signing Domain. String N
ip Return campaigns that have been sent using the specified IP address. Valid IP N

Error Responses

Description Code Cause
Invalid campaign ID. 404 The unique identifier of the campaign is invalid
Invalid X-Header. 404 We couldn't find any campaigns using your X-Header
Invalid start date format. 404 The start date provided was submitted in an invalid format
Invalid end date format. 404 The end date provided was submitted in an invalid format
No results found. 404 We couldn't find any results matching your criteria.