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 address
• from_domain – group by from domain

Request example

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "campaign_id": 116,
    "date_from": "2024-04-26",
    "date_to": "2024-05-01",
    "format": "json",
    "top": 2
}

XML

<xml>
    <token>abcdefghijklmnqrstuvwxyz</token>
    <campaign_id>116</campaign_id>
    <date_from>2024-04-26</date_from>
    <date_to>2024-05-01</date_to>
    <format>json</format>
    <top>2</top>
</xml>

Response example

JSON

{
    "data": [
        {
            "data_id": "",
            "count": 3,
            "bounce_text": "This response is sent when the message simply failed. Often times this is not caused by you, but rather because of a far-end server problem",
            "to_domain": "example.com"
        },
        {
            "data_id": "",
            "count": 3,
            "bounce_text": "This response is sent when the message simply failed. Often times this is not caused by you, but rather because of a far-end server problem",
            "to_domain": "jetwire.name"
        }
    ],
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
    <error>0</error>
    <error_text>Successful operation</error_text>
    <data>
        <data_id></data_id>
        <count>3</count>
        <bounce_text>This response is sent when the message simply failed. Often times this is not caused by you, but rather because of a far-end server problem</bounce_text>
        <to_domain>example.com</to_domain>
    </data>
    <data>
        <data_id></data_id>
        <count>3</count>
        <bounce_text>This response is sent when the message simply failed. Often times this is not caused by you, but rather because of a far-end server problem</bounce_text>
        <to_domain>jetwire.name</to_domain>
    </data>
</xml>

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