This is an old revision of the document!

API Email Report Endpoints

The Email Report Endpoints are used to get Reporting data regarding an Email back from Sentori.

Email KPI

This Endpoint is used to get the Emails KPI, you can also restrict it to a specific Iteration of the Email.

URI	https://api.sentoriapp.com/v2.0/email/kpi/EmailExternalID/
URI	https://api.sentoriapp.com/v2.0/email/kpi/EmailExternalID/Iteration/
Method	GET

Response

Example

{
    "Sent":100,
    "Bounced":10,
    "Opens":25,
    "UniqueClickers":20,
    "TotalClicks":23,
    "SocialShares":0,
    "SocialKpi": {
        "GooglePlusOnes":0,
        "LinkedInShares":0,
        "Tweets":0,
        "FacebookLikes":0
    },
   "Unsubscribes":1,
   "AbuseComplaints":4
}

Abuse Complaints

This Endpoint is used to get the Contacts who complained that the Email was spam.

URI	https://api.sentoriapp.com/v2.0/email/abuse/EmailExternalID/
Method	GET

Response

The response is a JSON array containing Email Addresses of Contacts and the time of the Abuse Complaint.

Example

[{
    "EmailAddress":"joe.blogs@example.com",
    "Timestamp":Date(1361462400000)
}]

Bounces

This Endpoint is used to get the Contacts whose Email Addresses bounced when they where sent the Email. It can be restricted to a specific Iteration.

URI	https://api.sentoriapp.com/v2.0/email/bounced/EmailExternalID/
URI	https://api.sentoriapp.com/v2.0/email/bounced/EmailExternalID/Iteration
Method	GET

Response

The response is a JSON array containing Email Addresses of Contacts and the time of the bounce.

Example

[{
    "EmailAddress":"joe.blogs@example.com",
    "Timestamp":Date(1361462400000)
}]