Returns a page of contacts that subscribed for the given account. The contacts can be filtered either by a date interval or one or a list of mailing IDs (DOI Mailings). Note that this only returns subscribers that were subscribed by a DOI mailing that was sent through Maileon.
1 |
GET https://api.maileon.com/1.0/reports/subscribers |
Attributes
Parameter | Default | Description |
from_date | If provided, only the new subscribers having acknowledged a DOI confirmation link 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 new subscribers having acknowledged a DOI confirmation link before (excluding) the given date will be returned. 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 subscribers by (DOI) 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_contacts | true | Supported values: true / false. If set to true, the subscribers that cannot be mapped to contacts because of permission types or because of unsubscription 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 4 |
GET https://api.maileon.com/1.0/reports/subscribers?page_index=1&page_size=100&from_date=1395615600000&to_date=1395615600000&standard_field=TITLE&custom_field=KEYACCOUNT&exclude_anonymous_contacts=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 |
Status: 200 OK Content-Type: application/vnd.maileon.api+xml Link: ... X-Pages: ... X-Items: ... <subscribers> <subscriber> <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-24 09:49:15</timestamp> <mailing_id nil="true"></mailing_id> </subscriber> </subscribers> |
The response may contain the attribute “ip” in addition if logging the IP is enabled in Maileon: Settings – Contact-Management.
1 2 3 4 5 |
<subscriber> ... <mailing_id>726</mailing_id> <ip>95.213.17.23</ip> </subscriber> |