Overview
You can use this request to retrieve reports on a specific email. Use the ID of the email you want the reports on, and specify which report you want the system to return.
Please note that this API functionality will soon be deprecated. Have a look at the newest iteration here.
The Method
| API | Method | Endpoint |
|---|---|---|
| REST | GET | https://[Your URL]/api/2.0/emails/:id/report/:report |
| XML-RPC | Call | email._reports.EmailReports |
Parameters
| Property | Type | Description | Default | Required | Read Only |
|---|---|---|---|---|---|
| $id | integer | The ID of the email to report on. | empty | yes | no |
| $report | string | The type of report to return Possible values: overview: A general overview of the email contacts: Contact activity on the email links: Link performance on the email locations: Locations the email was delivered to bounces: Bounced emails from the message social: Social activity on the email unsubscribes: Contacts who unsubscribed forwards: Contacts who forwarded the message clicks: Link clicks for the message send-log: A list of every contact who was sent the message | overview | yes | no |
Example Response
{
"links": [
{
"title": "Self",
"rel": "self",
"href": "https://live.everlytic.net/api/2.0/emails/12345/report/contacts"
},
{
"title": "Home",
"rel": "home",
"href": "https://live.everlytic.net/api/2.0/"
},
{
"title": "ListEmails",
"rel": "collection",
"href": "https://live.everlytic.net/api/2.0/emails"
}
],
"item": {
"message": {
"message_total_sent": "2",
"message_total_failed": "0",
"message_total_to_be_queued": "2",
"message_total_queued": "2",
"message_total_in_queue": "0",
"message_queue_count": "0",
"message_last_queue_date": "0",
"message_total_link_clicks": "0",
"message_total_link_clicks_unique": "0",
"message_total_reads": "1",
"message_total_reads_inferred": "0",
"message_total_reads_unique": "1",
"message_total_unsubscribes": "0",
"message_total_bounces": "0",
"message_total_bounces_hard": "0",
"message_total_bounces_soft": "0",
"message_total_bounces_policy": "0",
"message_total_bounces_blacklist": "0",
"message_total_complaints": "0",
"message_total_complaints_real": "0",
"message_total_complaints_fbl": "0",
"message_total_forwards": "0",
"message_total_updates": "0",
"message_total_facebook_opens": "0",
"message_total_twitter_opens": "0",
"message_total_linkedin_opens": "0",
"message_total_replies": "0",
"message_total_replies_unique": "0",
"message_total_autoresponders": "0",
"message_total_bounces_unidentified": "0",
"message_sms_delivery_report": "0"
},
"open_stats": [],
"type": "daily",
"contacts": [],
"page": 1,
"total_pages": 0
}
}