====== 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.

|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 |

==== Response ====

|Example|<code javascript>{
    "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
}</code>|

===== Abuse Complaints =====

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>|
|Method| GET |

==== Response ====

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

|Example|<code javascript>[{
    "EmailAddress":"joe.blogs@example.com",
    "Timestamp":"\/Date(1361462400000)\/"
}]</code>|

===== 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.

|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 |

==== Response ====

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

|Example|<code javascript>[{
    "EmailAddress":"joe.blogs@example.com",
    "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>|