Table of Contents

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

FieldTypeDescription
SentintNumber of Contacts this Email was Sent to.
BouncedintNumber of Emails that bounced.
OpensintNumber of Contacts who opened this Email.
UniqueClickersintNumber of Contacts who clicked a link in this Email.
TotalClicksintTotal number of clicks on links in this Email.
SocialSharesintNumber of times this Email was shared on Social Networks
SocialKpiobjectContains a breakdown of the number of times this Email was shared on Social Networks.
UnsubscribesintThe number of Contacts who Unsubscribed.
AbuseComplaintsintThe 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.

FieldTypeDescription
EmailAddressstringEmail Address of the Contact who reported this Email as spam.
TimestampdatetimeTime 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.

FieldTypeDescription
EmailAddressstringEmail Address of the Contact who bounced.
TimestampdatetimeTime 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.

FieldTypeDescription
EmailAddressstringEmail Address of the Contact who clicked.
TimestampdatetimeTime of the click.
Example
[{
    "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.

Endpoint

URI https://api.sentoriapp.com/v2.0/email/linkclickers/{EmailExternalID}/{Base64EncodedUrl}/
URI https://api.sentoriapp.com/v2.0/email/linkclickers/{EmailExternalID}/{Base64EncodedUrl}/{Iteration}/
Method GET

Examples:

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

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

Request

EmailExternalIDThe External ID of the Email, e.g. “ABCD1234”. Found by going to Edit Properties from the cog menu of an Email.
Base64EncodedUrlThe URL of the link encoded using base64. “http://mywebsite.com/” would therefore be “aHR0cDovL215d2Vic2l0ZS5jb20v”.
IterationOptional. 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.

FieldTypeDescription
SystemIDintegerSentori SystemID of the Contact.
EmailAddressstringEmail Address of the Contact.
FirstClickdatetimeDate and time (in UTC) when the Contact first clicked the link.
Example
[
	{
		"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"
	}
]

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.

FieldTypeDescription
EmailAddressstringEmail Address of the Contact who opened the Email.
TimestampdatetimeTime 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.

FieldTypeDescription
EmailAddressstringEmail Address of the Contact who shared the Email on a Social Network.
TimestampdatetimeTime 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.

FieldTypeDescription
EmailAddressstringEmail Address of the Contact who unsubscribed.
TimestampdatetimeTime of the unsubscribe.
Example
[{
    "EmailAddress":"joe@example.sentoriapp.com",
    "Timestamp":"2015-01-01T00:00:00.000"
}]