API Guide







Get Recipient History

Get activity, engagement and events from a specific email address, with optional date and scope filter.

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

Endpoint URL:

https://api.250ok.com/api/1.0/analytics/recipient

Sample Output:

{
    "activity": {
        "created": 0,
        "deferred": 0,
        "delivered": 0,
        "bounced": 0,
        "filtered": 0,
        "click": 0,
        "read": 0,
        "forward": 0,
        "print": 0,
        "unsubscribe": 0
    },
    "engagement": {
        "read": 0,
        "skimmed": 0,
        "glancedorunread": 0
    },
    "events": {
        "created": [],
        "deferred": [],
        "delivered": [],
        "bounced": [],
        "filtered": [],
        "click": [],
        "forward": [],
        "print": [],
        "unsubscribe": [],
        "read": [
            {
                "eventday": "2019-04-08",
                "eventhour": "2019-04-08 23:00:00",
                "eventminute": "2019-04-08 23:13:00",
                "campaign_id": 1,
                "message_id": 0,
                "ip": "127.0.0.1",
                "fromaddress": "sender@domain.com",
                "toaddress": "receiver@mailbox.com",
                "todomain": "mailbox.com",
                "provider": "Gmail",
                ...
            }
        ]
    }
}
        

Parameters

Parameter Description Acceptable Values Required
toaddress The to-address which you're searching for activity on. String Y
startdate Includes activity after the specified date. If unspecified, it will default to the last 7 days. yyyy-mm-dd N
enddate Includes activity detected before the specified. If unspecified, it will default to the current date. yyyy-mm-dd N
include A pipe-delimited list of event types. To return all events, use this example: include=created|deferred|delivered|bounced|filtered|click|read|unsubscribe String N

Error Responses

Description Code Cause
Invalid email. 404 E-mail was not supplied or is invalid.
Invalid start date format. 404 startdate was supplied, but not in the format yyyy-mm-dd or the date is invalid (like 2019-02-31).
Invalid end date format. 404 enddate was supplied, but not in the format yyyy-mm-dd or the date is invalid (like 2019-03-32).
Invalid include: [include]. 404 An invalid include value was provided - please refer to the pipe-delimited list of valid includes in the parameters table above.