This method returns a page of contacts that received at least one mailing. The results can be filtered by one or more mailings and/or the time interval to get specific contacts e.g. for a given campaign.
1 |
GET https://api.maileon.com/1.0/reports/recipients |
1 |
GET https://api.maileon.com/1.0/reports/recipients/count |
Attributes
Parameter | Default | Description |
from_date | If provided, only the recipients 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 recipients before (excluding) the given date will be returned. This can be used e.g. for trigger mailings. The value of to_date must be a numeric value representing a point in time milliseconds after January 1, 1970 00:00:00 | |
mailing_id | Multivalued parameter to filter the recipients 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_deleted_recipients | false | Supported values: true / false. If set to true, the recipients that have been removed from maileon will be excluded. |
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/recipients?page_index=1&page_size=100&mailing_id=3&mailing_id=116&from_date=1395615600000&to_date=1395615600000&standard_field=TITLE&;custom_field=KEYACCOUNT&exclude_deleted_recipients=false Accept: application/vnd.maileon.api+xml; charset=utf-8 Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXX |
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 |
Status: 200 OK Content-Type: application/vnd.maileon.api+xml Link: ... X-Pages: ... X-Items: ... <recipients> <recipient> <contact anonymous="true"></contact> <timestamp>2014-03-17 16:36:40</timestamp> <mailing_id>116</mailing_id> </recipient> <recipient> <contact anonymous="true"></contact> <timestamp>2014-03-17 16:36:40</timestamp> <mailing_id>116</mailing_id> </recipient> <recipient> <contact> <id>882</id> <email>max.mustermann@xqueue.com</email> <permissionstatus>available</permissionstatus> <permissiontype>doi</permissiontype> <external_id nil="true"></external_id> <standard_fields> <field> <name>TITLE</name> <value>Freigraf</value> </field> </standard_fields> <custom_fields> <field> <name>KEYACCOUNT</name> <value>1</value> </field> </custom_fields> </contact> <timestamp>2014-03-17 16:36:40</timestamp> <mailing_id>116</mailing_id> </recipient> </recipients> |