Returns a page of bounces. The difference to “Get Bounces” is that this resource searches for the last bounce of a tuple (contact, mailing) and returns it along with the aggregated number of bounces of the same type the contact had in the past with a mailing.
Please note that this is for regular mailings usually one as only one bounce is saved while trying to deliver the mailing. There are rare cases where misconfigured mailservers send several bounces at once, so it might be possible that several bounces are registered.
For mailings with the same ID, e.g. trigger mailings, the amount can be greater (until the contact is blocked by the bounce policy).
1 |
GET https://api.maileon.com/1.0/reports/bounces/unique |
1 |
GET https://api.maileon.com/1.0/reports/bounces/unique/count |
Attributes
Parameter | Default | Description |
from_date | If provided, only the bounces after or equal (including) the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds after January 1, 1970 00:00:00 | |
to_date | If provided, only the bounces before (excluding) the given date will be returned./ The value of to_date must be a numeric value representing a point in time milliseconds afterJanuary 1, 1970 00:00:00 | |
mailing_id | Multivalued parameter to filter the bounces by mailings. Each value must correspond to a mailing id. | |
ids | Multivalued parameter to filter the results by contacts. Each value must correspond to a contact id. | |
emails | Multivalued parameter to filter the results by email addresses. | |
eids | Multivalued parameter to filter the results by external ids. Each value must correspond to a contacts external id | |
exclude_anonymous_bounces | true | Supported values: true / false. If set to true, the bounces that cannot be mapped to contacts because of permission types or because unsubscriptions are omitted in the results. |
standard_field | Multivalued parameter to query the value of a standard contact field. | |
custom_field | Multivalued parameter to query the value of a custom contact field. | |
page_index | 1 | The index of the result page. The index must be greater or equal to 1. |
page_size | 100 | The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000. |
Example
1 2 3 |
GET https://api.maileon.com/1.0/reports/bounces/unique?page_index=3&page_size=1000 Authorization: Basic XXXXXXXXXXXXXXX Accept: application/vnd.maileon.api+xml; charset=utf-8 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
Status: 200 OK Content-Type: application/vnd.maileon.api+xml Link: ... X-Pages: ... X-Items: ... <!--?xml version="1.0" encoding="UTF-8"?--> <unique_bounces> <unique_bounce> <contact> <id>24105615</id> <email>...</email> <permissionstatus>available</permissionstatus> <permissiontype>doi+</permissiontype> <external_id nil="true"></external_id> <standard_fields></standard_fields> <custom_fields></custom_fields> </contact> <timestamp>2015-01-30 14:00:50</timestamp> <mailing_id>172</mailing_id> <last_type>transient</last_type> <count>5</count> <count_hard>5</count_hard> <count_soft>0</count_soft> </unique_bounce> <unique_bounce> <contact> <id>5456696</id> <email>...</email> <permissionstatus>none</permissionstatus> <permissiontype>none</permissiontype> <external_id nil="true"></external_id> <standard_fields></standard_fields> <custom_fields></custom_fields> </contact> <timestamp>2014-06-20 22:08:00</timestamp> <mailing_id>14</mailing_id> <last_type>transient</last_type> <count>3</count> <count_hard>0</count_hard> <count_soft>3</count_soft> </unique_bounce> ... </unique_bounces> |