Get undeliveries report
Description
Retrieves undelivered messages report.
Request URL
Method: POST
https://example.com/api/v1.1/reports/undelivered
Request parameters
Parameter | Type | Example | Required | Description |
---|---|---|---|---|
token | string | "abcdefghijklmnqrstuvwxyz" | Yes | API token |
format | string | "json" | No | Response data format. By default – json |
date_from | string | "2018-08-10" | Yes | Report start date |
date_to | string | "2018-08-15" | Yes | Report end date |
campaign_id | int | 1 | No | Campaign ID |
group_by | string | "from_domain" | No | Group data by ... |
top | int | 2 | No | Top X undeliveries |
group_by
possible values:
ip
– group by sender IP addressfrom_domain
– group by from domain
Request example
{
"campaign_id": 1,
"date_from": "2018-08-10",
"date_to": "2018-08-15",
"format": "json",
"token": "abcdefghijklmnqrstuvwxyz",
"top": 2
}
Response example
{
"data": [
{
"bounce_text": "TTL reached",
"count": 5,
"data_id": "",
"to_domain": "undeliv.report.net"
},
{
"bounce_text": "Unroutable",
"count": 5,
"data_id": "",
"to_domain": "undeliv.report.net"
}
],
"error": 0,
"error_text": "Successful operation"
}
Response parameters
Parameter | Type | Description |
---|---|---|
error | int | Error code |
error_text | string | Error text |
bounce_text | string | Email provider response |
count | int | Email provider response count |
data_id | string | Data source ID |
to_domain | string | Domain |