This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
api:v2.0:email-report [2015/01/20 17:14] dan |
api:v2.0:email-report [2017/07/24 14:15] (current) |
||
|---|---|---|---|
| Line 43: | Line 43: | ||
| |Example|<code javascript>[{ | |Example|<code javascript>[{ | ||
| "EmailAddress":"joe.blogs@example.com", | "EmailAddress":"joe.blogs@example.com", | ||
| - | "Timestamp":Date(1361462400000) | + | "Timestamp":"\/Date(1361462400000)\/" |
| }]</code>| | }]</code>| | ||
| Line 51: | Line 51: | ||
| |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/bounced/EmailExternalID/</nowiki>| | |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>| | + | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/bounced/EmailExternalID/Iteration/</nowiki>| |
| |Method| GET | | |Method| GET | | ||
| Line 60: | Line 60: | ||
| |Example|<code javascript>[{ | |Example|<code javascript>[{ | ||
| "EmailAddress":"joe.blogs@example.com", | "EmailAddress":"joe.blogs@example.com", | ||
| - | "Timestamp":Date(1361462400000) | + | "Timestamp":"\/Date(1361462400000)\/" |
| + | }]</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. | ||
| + | |||
| + | |Example|<code javascript>[{ | ||
| + | "EmailAddress":"joe.blogs@example.com", | ||
| + | "Timestamp":"\/Date(1361462400000)\/" | ||
| + | }]</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. | ||
| + | |||
| + | |Example|<code javascript>[{ | ||
| + | "EmailAddress":"joe.blogs@example.com", | ||
| + | "Timestamp":"\/Date(1361462400000)\/" | ||
| + | }]</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. | ||
| + | |||
| + | |Example|<code javascript>[{ | ||
| + | "EmailAddress":"joe.blogs@example.com", | ||
| + | "Timestamp":"\/Date(1361462400000)\/" | ||
| + | }]</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. | ||
| + | |||
| + | |Example|<code javascript>[{ | ||
| + | "EmailAddress":"joe.blogs@example.com", | ||
| + | "Timestamp":"\/Date(1361462400000)\/" | ||
| }]</code>| | }]</code>| | ||