API Email Report Endpoints

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.

This Endpoint is used to get the Contacts who complained that the Email was spam.

The response is a JSON array containing Email Addresses of Contacts and the time of the Abuse Complaint.

[{
    "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.

The response is a JSON array containing Email Addresses of Contacts and the time of the bounce.

[{
    "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.

The response is a JSON array containing Email Addresses of Contacts and the time of the first click.

[{
    "EmailAddress":"joe@example.sentoriapp.com",
    "Timestamp":"2015-01-01T00:00:00.000"
}]

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.

Examples:

GET https://api.sentoriapp.com/v2.0/email/linkclickers/ABCD1234/aHR0cDovL215d2Vic2l0ZS5jb20v/

GET https://api.sentoriapp.com/v2.0/email/linkclickers/ABCD1234/aHR0cDovL215d2Vic2l0ZS5jb20v/3

The response is a JSON array containing Contacts' SystemIDs, Email Addresses and the date and time of their first click of the link.

[
	{
		"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"
	}
]

This Endpoint is used to get the Contacts who have opened the Email. It can be restricted to a specific Iteration.

The response is a JSON array containing Email Addresses of Contacts and the time of the first open.

[{
    "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.

The response is a JSON array containing Email Addresses of Contacts and the time of the first social share.

[{
    "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.

The response is a JSON array containing Email Addresses of Contacts and the time of the unsubscribe.

[{
    "EmailAddress":"joe@example.sentoriapp.com",
    "Timestamp":"2015-01-01T00:00:00.000"
}]