This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
api-email-reports [2015/03/04 11:55] dan |
api-email-reports [2017/07/26 08:24] (current) |
||
---|---|---|---|
Line 7: | Line 7: | ||
This Endpoint is used to get the Emails KPI, you can also restrict it to a specific Iteration of the Email. | 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>| | + | ==== Endpoint ==== |
- | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/kpi/EmailExternalID/Iteration/</nowiki>| | + | |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 | | |Method| GET | | ||
Line 45: | Line 46: | ||
This Endpoint is used to get the Contacts who complained that the Email was spam. | 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>| | + | ==== Endpoint ==== |
+ | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/abuse/{EmailExternalID}/</nowiki>| | ||
|Method| GET | | |Method| GET | | ||
Line 65: | Line 67: | ||
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. | 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>| | + | ==== Endpoint ==== |
- | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/bounced/EmailExternalID/Iteration/</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>| | ||
|Method| GET | | |Method| GET | | ||
Line 83: | Line 86: | ||
===== Clickers ===== | ===== 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. | 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>| | + | ==== Endpoint ==== |
- | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/clicks/EmailExternalID/Iteration/</nowiki>| | + | |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 | | |Method| GET | | ||
Line 104: | Line 107: | ||
}]</code>| | }]</code>| | ||
- | ===== Opens ===== | ||
+ | ===== Link Clickers ===== | ||
+ | |||
+ | This Endpoint is used to get details of Contacts who clicked through to a particular link in an Email and includes when each made their first click of that link. | ||
+ | |||
+ | If the exact same link URL appears multiple times within the Email, for example a link to your homepage is set on your logo as well as in your footer, then they'll be considered the same link. | ||
+ | |||
+ | |||
+ | ==== Endpoint ==== | ||
+ | |||
+ | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/linkclickers/{EmailExternalID}/{Base64EncodedUrl}/</nowiki>| | ||
+ | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/linkclickers/{EmailExternalID}/{Base64EncodedUrl}/{Iteration}/</nowiki>| | ||
+ | |Method| GET | | ||
+ | |||
+ | |||
+ | Examples: | ||
+ | |||
+ | <nowiki>GET https://api.sentoriapp.com/v2.0/email/linkclickers/ABCD1234/aHR0cDovL215d2Vic2l0ZS5jb20v/</nowiki> | ||
+ | |||
+ | <nowiki>GET https://api.sentoriapp.com/v2.0/email/linkclickers/ABCD1234/aHR0cDovL215d2Vic2l0ZS5jb20v/3</nowiki> | ||
+ | |||
+ | |||
+ | ==== Request ==== | ||
+ | |||
+ | |EmailExternalID|The External ID of the Email, e.g. "ABCD1234". Found by going to Edit Properties from the cog menu of an Email.| | ||
+ | |Base64EncodedUrl|The URL of the link encoded using [[https://en.wikipedia.org/wiki/Base64|base64]]. "<nowiki>http://mywebsite.com/</nowiki>" would therefore be "aHR0cDovL215d2Vic2l0ZS5jb20v".| | ||
+ | |Iteration|Optional. If provided, restricts Clicks to those made in a particular send of the Email.| | ||
+ | |||
+ | |||
+ | ==== Response ==== | ||
+ | |||
+ | The response is a JSON array containing Contacts' SystemIDs, Email Addresses and the date and time of their first click of the link. | ||
+ | |||
+ | |Field|Type|Description| | ||
+ | |SystemID|integer|Sentori SystemID of the Contact.| | ||
+ | |EmailAddress|string|Email Address of the Contact.| | ||
+ | |FirstClick|datetime|Date and time (in UTC) when the Contact first clicked the link.| | ||
+ | |||
+ | |Example|<code javascript> | ||
+ | [ | ||
+ | { | ||
+ | "SystemID" : 1, | ||
+ | "EmailAddress" : "contact1@sentori.co.uk", | ||
+ | "FirstClick" : "2013-02-21T17:11:57.53" | ||
+ | }, | ||
+ | { | ||
+ | "SystemID" : 2, | ||
+ | "EmailAddress" : "contact2@sentori.co.uk", | ||
+ | "FirstClick" : "2013-02-21T17:11:57.53" | ||
+ | } | ||
+ | ] | ||
+ | </code>| | ||
+ | |||
+ | |||
+ | ===== Opens ===== | ||
This Endpoint is used to get the Contacts who have opened the Email. It can be restricted to a specific Iteration. | 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>| | + | ==== Endpoint ==== |
- | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/opens/EmailExternalID/Iteration/</nowiki>| | + | |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 | | |Method| GET | | ||
Line 131: | Line 188: | ||
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. | 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>| | + | ==== Endpoint ==== |
- | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/socialsharers/EmailExternalID/Iteration/</nowiki>| | + | |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 | | |Method| GET | | ||
Line 152: | Line 210: | ||
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. | 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>| | + | ==== Endpoint ==== |
- | |URI| <nowiki>https://api.sentoriapp.com/v2.0/email/unsubscribes/EmailExternalID/Iteration/</nowiki>| | + | |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 | | |Method| GET | | ||