This shows you the differences between two versions of the page.
api-email-reports [2015/03/04 11:55] dan |
api-email-reports [2017/07/26 08:24] |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== 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| <nowiki>https://api.sentoriapp.com/v2.0/email/kpi/EmailExternalID/</nowiki>| | ||
- | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/kpi/EmailExternalID/Iteration/</nowiki>| | ||
- | |Method| GET | | ||
- | |||
- | ==== Response ==== | ||
- | |||
- | |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|<code javascript>{ | ||
- | "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 | ||
- | }</code>| | ||
- | |||
- | ===== Abuse Complaints ===== | ||
- | |||
- | This Endpoint is used to get the Contacts who complained that the Email was spam. | ||
- | |||
- | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/abuse/EmailExternalID/</nowiki>| | ||
- | |Method| GET | | ||
- | |||
- | ==== Response ==== | ||
- | |||
- | The response is a JSON array containing Email Addresses of Contacts and the time of the Abuse Complaint. | ||
- | |||
- | |Field|Type|Description| | ||
- | |EmailAddress|string|Email Address of the Contact who reported this Email as spam.| | ||
- | |Timestamp|datetime|Time that the Contact complained about this Email.| | ||
- | |||
- | |Example|<code javascript>[{ | ||
- | "EmailAddress":"joe@example.sentoriapp.com", | ||
- | "Timestamp":"2015-01-01T00:00:00.000" | ||
- | }]</code>| | ||
- | |||
- | ===== 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| <nowiki>https://api.sentoriapp.com/v2.0/email/bounced/EmailExternalID/</nowiki>| | ||
- | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/bounced/EmailExternalID/Iteration/</nowiki>| | ||
- | |Method| GET | | ||
- | |||
- | ==== Response ==== | ||
- | |||
- | The response is a JSON array containing Email Addresses of Contacts and the time of the bounce. | ||
- | |||
- | |Field|Type|Description| | ||
- | |EmailAddress|string|Email Address of the Contact who bounced.| | ||
- | |Timestamp|datetime|Time that the Email bounced.| | ||
- | |||
- | |Example|<code javascript>[{ | ||
- | "EmailAddress":"joe@example.sentoriapp.com", | ||
- | "Timestamp":"2015-01-01T00:00:00.000" | ||
- | }]</code>| | ||
- | |||
- | ===== Clickers ===== | ||
- | |||
- | |||
- | 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| <nowiki>https://api.sentoriapp.com/v2.0/email/clicks/EmailExternalID/</nowiki>| | ||
- | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/clicks/EmailExternalID/Iteration/</nowiki>| | ||
- | |Method| GET | | ||
- | |||
- | ==== Response ==== | ||
- | |||
- | The response is a JSON array containing Email Addresses of Contacts and the time of the first click. | ||
- | |||
- | |Field|Type|Description| | ||
- | |EmailAddress|string|Email Address of the Contact who clicked.| | ||
- | |Timestamp|datetime|Time of the click.| | ||
- | |||
- | |Example|<code javascript>[{ | ||
- | "EmailAddress":"joe@example.sentoriapp.com", | ||
- | "Timestamp":"2015-01-01T00:00:00.000" | ||
- | }]</code>| | ||
- | |||
- | ===== Opens ===== | ||
- | |||
- | |||
- | This Endpoint is used to get the Contacts who have opened the Email. It can be restricted to a specific Iteration. | ||
- | |||
- | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/opens/EmailExternalID/</nowiki>| | ||
- | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/opens/EmailExternalID/Iteration/</nowiki>| | ||
- | |Method| GET | | ||
- | |||
- | ==== Response ==== | ||
- | |||
- | The response is a JSON array containing Email Addresses of Contacts and the time of the first open. | ||
- | |||
- | |Field|Type|Description| | ||
- | |EmailAddress|string|Email Address of the Contact who opened the Email.| | ||
- | |Timestamp|datetime|Time of the open.| | ||
- | |||
- | |Example|<code javascript>[{ | ||
- | "EmailAddress":"joe@example.sentoriapp.com", | ||
- | "Timestamp":"2015-01-01T00:00:00.000" | ||
- | }]</code>| | ||
- | |||
- | |||
- | ===== Social Shares ===== | ||
- | |||
- | 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| <nowiki>https://api.sentoriapp.com/v2.0/email/socialsharers/EmailExternalID/</nowiki>| | ||
- | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/socialsharers/EmailExternalID/Iteration/</nowiki>| | ||
- | |Method| GET | | ||
- | |||
- | ==== Response ==== | ||
- | |||
- | The response is a JSON array containing Email Addresses of Contacts and the time of the first social share. | ||
- | |||
- | |Field|Type|Description| | ||
- | |EmailAddress|string|Email Address of the Contact who shared the Email on a Social Network.| | ||
- | |Timestamp|datetime|Time of the share.| | ||
- | |||
- | |Example|<code javascript>[{ | ||
- | "EmailAddress":"joe@example.sentoriapp.com", | ||
- | "Timestamp":"2015-01-01T00:00:00.000" | ||
- | }]</code>| | ||
- | |||
- | ===== Unsubscribes ===== | ||
- | |||
- | 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| <nowiki>https://api.sentoriapp.com/v2.0/email/unsubscribes/EmailExternalID/</nowiki>| | ||
- | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/unsubscribes/EmailExternalID/Iteration/</nowiki>| | ||
- | |Method| GET | | ||
- | |||
- | ==== Response ==== | ||
- | |||
- | The response is a JSON array containing Email Addresses of Contacts and the time of the unsubscribe. | ||
- | |||
- | |Field|Type|Description| | ||
- | |EmailAddress|string|Email Address of the Contact who unsubscribed.| | ||
- | |Timestamp|datetime|Time of the unsubscribe.| | ||
- | |||
- | |Example|<code javascript>[{ | ||
- | "EmailAddress":"joe@example.sentoriapp.com", | ||
- | "Timestamp":"2015-01-01T00:00:00.000" | ||
- | }]</code>| |