Get Delivery Reports
To get a report consisting of key data points such as bounces, sent, deliveries etc.
Request Type
- GET
Request URL
https://campaigns.zoho.com/emailapi/v2/reports/delivery/summary
Content-Type
application/json
List of Response Body Attributes
| Parameters | Data Type | Description |
| data | JSON Object | |
| summary | JSON Object | Contains the overview of various aspects of email delivery. |
| total_sent_count | Integer | Total emails sent. |
| total_delivered_count | Integer | Total emails delivered. |
| total_opened_count | Integer | Total emails opened. |
| total_click_count | Integer | Total links clicked in emails. |
| total_bounce_count | Integer | Total emails bounced. |
| total_spam_count | Integer | Total emails landed in spam. |
| stats | JSON Object | Stats of various aspects of email delivery at a particular time. |
| spam_count | Integer | Number of emails landed in spam. |
| delivered_count | Integer | Number of emails delivered. |
| opened_count | Integer | Number of emails opened. |
| bounce_count | Integer | Number of emails bounced. |
| click_count | Integer | Number of links clicked in emails. |
| sent_count | Integer | Number of emails sent. |
| timestamp | Long | Time (in milliseconds) at which the report was generated. |
| time_precision | String | Specifies the granularity of the time intervals for grouping the reports. |
| response | JSON Object | Contains the response details of the API. |
| code | Integer | Success or failure code. |
| message | String | Success or failure message returned by the API. |
| errors | JSON Object | Contains the error details of the API such as 'code' and 'message'. |
Sample Response - Success
Copied{
"data": {
"summary": {
"total_sent_count": 34876,
"total_delivered_count": 34876,
"total_opened_count": 0,
"total_click_count": 0,
"total_bounce_count": 0,
"total_spam_count": 0
},
"stats": [
{
"spam_count": 0,
"delivered_count": 16500,
"opened_count": 0,
"bounce_count": 0,
"click_count": 0,
"sent_count": 16500,
"timestamp": 1680771600000
},
{
"spam_count": 0,
"delivered_count": 9672,
"opened_count": 0,
"bounce_count": 0,
"click_count": 0,
"sent_count": 9672,
"timestamp": 1680778800000
},
{
"spam_count": 0,
"delivered_count": 8674,
"opened_count": 0,
"bounce_count": 0,
"click_count": 0,
"sent_count": 8674,
"timestamp": 1680865200000
},
{
"spam_count": 0,
"delivered_count": 6,
"opened_count": 0,
"bounce_count": 0,
"click_count": 0,
"sent_count": 6,
"timestamp": 1681110000000
},
{
"spam_count": 0,
"delivered_count": 2,
"opened_count": 0,
"bounce_count": 0,
"click_count": 0,
"sent_count": 2,
"timestamp": 1681124400000
},
{
"spam_count": 0,
"delivered_count": 3,
"opened_count": 0,
"bounce_count": 0,
"click_count": 0,
"sent_count": 3,
"timestamp": 1681189200000
},
{
"spam_count": 0,
"delivered_count": 10,
"opened_count": 0,
"bounce_count": 0,
"click_count": 0,
"sent_count": 10,
"timestamp": 1681192800000
},
{
"spam_count": 0,
"delivered_count": 2,
"opened_count": 0,
"bounce_count": 0,
"click_count": 0,
"sent_count": 2,
"timestamp": 1681711200000
},
{
"spam_count": 0,
"delivered_count": 5,
"opened_count": 0,
"bounce_count": 0,
"click_count": 0,
"sent_count": 5,
"timestamp": 1682067600000
},
{
"spam_count": 0,
"delivered_count": 2,
"opened_count": 0,
"bounce_count": 0,
"click_count": 0,
"sent_count": 2,
"timestamp": 1682085600000
}
],
"time_precision": "hourly"
},
"response": {
"code": 200301,
"message": "Successfully obtained the reports for the given criteria"
}
}Show full
Show less
Sample Response - Failure
Copied{
"errors": [
{
"code": 500301,
"message": "An error occurred in Reports API"
}
]
}
