+49 69 83008980 service@xqueue.com

Benötigen Sie Hilfe?

Get Recipients

Sie sind hier:
< Alle Themen
 

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.

GET https://api.maileon.com/1.0/reports/recipients
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. 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 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_anonymous_blocks 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

GET https://api.maileon.com/1.0/reports/recipients?page_index=1&amp;page_size=100&amp;mailing_id=3&amp;mailing_id=116&amp;from_date=1395615600000&amp;to_date=1395615600000&amp;standard_field=TITLE&amp;;custom_field=KEYACCOUNT&amp;exclude_deleted_recipients=false
Accept: application/vnd.maileon.api+xml; charset=utf-8
Authorization: Basic XXXXXXXXXXXXXXXXXXXXXXX
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>

 

Inhaltsverzeichnis