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.
Endpoint
| URI | https://api.sentoriapp.com/v2.0/email/kpi/EmailExternalID/ |
| URI | https://api.sentoriapp.com/v2.0/email/kpi/EmailExternalID/Iteration/ |
| 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 | {
"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.
Endpoint
| 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.
| 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 | [{
"EmailAddress":"joe@example.sentoriapp.com",
"Timestamp":"2015-01-01T00:00:00.000"
}]
|
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.
Endpoint
| 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.
| Field | Type | Description |
| EmailAddress | string | Email Address of the Contact who bounced. |
| Timestamp | datetime | Time that the Email bounced. |
| Example | [{
"EmailAddress":"joe@example.sentoriapp.com",
"Timestamp":"2015-01-01T00:00:00.000"
}]
|
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.
Endpoint
| URI | https://api.sentoriapp.com/v2.0/email/clicks/EmailExternalID/ |
| URI | https://api.sentoriapp.com/v2.0/email/clicks/EmailExternalID/Iteration/ |
| 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 | [{
"EmailAddress":"joe@example.sentoriapp.com",
"Timestamp":"2015-01-01T00:00:00.000"
}]
|
Opens
This Endpoint is used to get the Contacts who have opened the Email. It can be restricted to a specific Iteration.
Endpoint
| URI | https://api.sentoriapp.com/v2.0/email/opens/EmailExternalID/ |
| URI | https://api.sentoriapp.com/v2.0/email/opens/EmailExternalID/Iteration/ |
| 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 | [{
"EmailAddress":"joe@example.sentoriapp.com",
"Timestamp":"2015-01-01T00:00:00.000"
}]
|
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.
Endpoint
| URI | https://api.sentoriapp.com/v2.0/email/socialsharers/EmailExternalID/ |
| URI | https://api.sentoriapp.com/v2.0/email/socialsharers/EmailExternalID/Iteration/ |
| 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 | [{
"EmailAddress":"joe@example.sentoriapp.com",
"Timestamp":"2015-01-01T00:00:00.000"
}]
|
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.
Endpoint
| URI | https://api.sentoriapp.com/v2.0/email/unsubscribes/EmailExternalID/ |
| URI | https://api.sentoriapp.com/v2.0/email/unsubscribes/EmailExternalID/Iteration/ |
| 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 | [{
"EmailAddress":"joe@example.sentoriapp.com",
"Timestamp":"2015-01-01T00:00:00.000"
}]
|