Returns a page of bounces. For a list of bounce codes, please check this page: bounce codes.
Bounces are collected when they are final, i.e. while the mailserver tries to submit a mailing and a temporal error (e.g. mailbox is full) is detected, the bounce is registered after the mailserver gave up retrying to deliver the mailing.
1 |
GET https://api.maileon.com/1.0/reports/bounces |
1 |
GET https://api.maileon.com/1.0/reports/bounces/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 | |
status_code | Multivalued parameter to filter the bounces by status codes. Status codes follow the pattern digit.digit.digit (example: 5.0.0) | |
type | Filters the bounces by type: permanent / transient | |
source_filter | Filters the bounces by their source: mta-listener / reply | |
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?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 |
Status: 200 OK Content-Type: application/vnd.maileon.api+xml Link: ... X-Pages: ... X-Items: ... <bounces> <bounce> <contact> <id>16608</id> <email>...</email> <external_id nil="true"></external_id> <standard_fields></standard_fields> <custom_fields></custom_fields> </contact> <timestamp>2013-04-18 07:00:38</timestamp> <mailing_id>172</mailing_id> <type>transient</type> <status_code>4.7.1</status_code> <source />mta-listener </bounce> <bounce> <contact> <id>5168</id> <email>...</email> <external_id nil="true"></external_id> <standard_fields></standard_fields> <custom_fields></custom_fields> </contact> <timestamp>2013-01-17 09:40:38</timestamp> <mailing_id>14</mailing_id> <type>permanent</type> <status_code>5.7.1</status_code> <source />mta-listener </bounce> ... </bounces> |