This is an old revision of the document!
The Email Report Endpoints are used to get Reporting data regarding an Email back from Sentori.
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 |
Field | Type | Description |
Sent | int | Number of Contacts this Email was Sent to. |
Bounced | int | Number of Emails that bounced. |
Opens | int | Number of Contacts who opened this Email. |
UniqueClickers | int | Number of Contacts who clicked a link in this Email. |
TotalClicks | int | Total number of clicks on links in this Email. |
SocialShares | int | Number of times this Email was shared on Social Networks |
SocialKpi | object | Contains a breakdown of the number of times this Email was shared on Social Networks. |
Unsubscribes | int | The number of Contacts who Unsubscribed. |
AbuseComplaints | int | The number of spam complains generated by this Email. |
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 } |
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 |
The response is a JSON array containing Email Addresses of Contacts and the time of the Abuse Complaint.
Example | [{ "EmailAddress":"joe@example.sentoriapp.com", "Timestamp":"2015-01-01T00:00:00.000" }] |
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 |
The response is a JSON array containing Email Addresses of Contacts and the time of the bounce.
Example | [{ "EmailAddress":"joe@example.sentoriapp.com", "Timestamp":"2015-01-01T00:00:00.000" }] |
This Endpoint is used to get the Contacts who clicked at least one Link in the Email. It can be restricted to a specific Iteration.
URI | https://api.sentoriapp.com/v2.0/email/clicks/EmailExternalID/ |
URI | https://api.sentoriapp.com/v2.0/email/clicks/EmailExternalID/Iteration/ |
Method | GET |
The response is a JSON array containing Email Addresses of Contacts and the time of the first click.
Example | [{ "EmailAddress":"joe@example.sentoriapp.com", "Timestamp":"2015-01-01T00:00:00.000" }] |
This Endpoint is used to get the Contacts who have opened the Email. It can be restricted to a specific Iteration.
URI | https://api.sentoriapp.com/v2.0/email/opens/EmailExternalID/ |
URI | https://api.sentoriapp.com/v2.0/email/opens/EmailExternalID/Iteration/ |
Method | GET |
The response is a JSON array containing Email Addresses of Contacts and the time of the first open.
Example | [{ "EmailAddress":"joe@example.sentoriapp.com", "Timestamp":"2015-01-01T00:00:00.000" }] |
This Endpoint is used to get the Contacts who have shared the Email on at least one social network. It can be restricted to a specific Iteration.
URI | https://api.sentoriapp.com/v2.0/email/socialsharers/EmailExternalID/ |
URI | https://api.sentoriapp.com/v2.0/email/socialsharers/EmailExternalID/Iteration/ |
Method | GET |
The response is a JSON array containing Email Addresses of Contacts and the time of the first social share.
Example | [{ "EmailAddress":"joe@example.sentoriapp.com", "Timestamp":"2015-01-01T00:00:00.000" }] |
This Endpoint is used to get the Contacts who have unsubscribed from Emails using the unsubscribe Link in this Email. It can be restricted to a specific Iteration.
URI | https://api.sentoriapp.com/v2.0/email/unsubscribes/EmailExternalID/ |
URI | https://api.sentoriapp.com/v2.0/email/unsubscribes/EmailExternalID/Iteration/ |
Method | GET |
The response is a JSON array containing Email Addresses of Contacts and the time of the unsubscribe.
Example | [{ "EmailAddress":"joe@example.sentoriapp.com", "Timestamp":"2015-01-01T00:00:00.000" }] |