+49 69 83008980 service@xqueue.com
Benötigen Sie Hilfe?

Im Maileon Help-Center finden Sie umfassende Dokumentationen zu unserem System.

Beliebte Suchanfragen: Importe | Rest-API | Integrationen | SMS

Get Filtered Contacts

Sie sind hier:

If a contact is excluded from some sendout, e.g. personalization errors or when the contact has a positive match on the mailing blocklist, the event can be pushed either using the corresponding webhook or pulled by querying this resource.
Please be aware: if the contact has a positive match on the account or global blocklist, it is not added to the distribution list in the first place, and thus, not excluded from sendout as it never was meant to be receiving the mail.

GET https://api.maileon.com/1.0/reports/filtered_contacts

GET https://api.maileon.com/1.0/reports/filtered_contacts/count

Query Parameters

Parameter Default Description
from_date If provided, only the opens 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 opens 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 opens 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_contacts true Supported values: true / false. If set to true, the excludes 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.
embed_transaction_id false If the set to true, the attribut „transaction_id“ of a transaction will be returned that caused this open, if available.
If this setting is set to true, it will add a ‚transaction_id‘ element to the result.
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.

Response Attributes

Attribute Description
contact The contact information, if non anonymized, containing id, email, permissionStatus, permissionType, created, updated, external_id, standard_fields (if requested), and custom_fields (if requested).
timestamp The timestamp of the event.
mailing_id The ID of the mailing,.
reason One of „account_property“, „custom_property“, „external_file“, „mailing_property“,
„other_property“, „standard_property“, „template“, „transaction“, „blocklist“, „attachment_cannot_be_downloaded„, „cpc“ (contact pressure control), „uri-personalization„, „mine“, or „unspecified_error“
reason_details THIS FIELD IS OPTIONAL and only available, if data is available, for reasons of type „account_property“, „custom_property“, „external_file“, „mailing_property“, „other_property“, „standard_property“, „template“, or „transaction“. In other cases it is NOT contained in the XML structure.

Example without reason_details

GET https://api.maileon.com/1.0/reports/filtered_contacts/count?page_index=1&page_size=100&exclude_anonymous_contacts=false

Status: 200 OK
Content-Type: application/vnd.maileon.api+xml
Link: ...
X-Pages: ...
X-Items: ...


<filtered_contacts>
  <filtered_contact>
    <contact>
      <id>3911</id>
      <email>max.mustermann@xqueue.com</email>
      <permissionStatus>available</permissionStatus>
      <permissionType>doi+</permissionType>
      <created>2019-02-05 09:08:30.0</created>
      <updated>2024-01-10 11:15:24.0</updated>
      <external_id>16243</external_id>
      <standard_fields/>
      <custom_fields/>
    </contact>
    <timestamp>2023-01-09 16:58:49</timestamp>
    <mailing_id>103</mailing_id>
    <reason>mine</reason>
  </filtered_contact>
  ...
<filtered_contacts>

Example with reason_details

GET https://api.maileon.com/1.0/reports/filtered_contacts/count?page_index=1&page_size=100&exclude_anonymous_contacts=false

Status: 200 OK
Content-Type: application/vnd.maileon.api+xml
Link: ...
X-Pages: ...
X-Items: ...


<filtered_contacts>
  <filtered_contact>
    <contact>
      <id>3911</id>
      <email>max.mustermann@xqueue.com</email>
      <permissionStatus>available</permissionStatus>
      <permissionType>doi+</permissionType>
      <created>2013-08-23 20:08:38.0</created>
      <updated>2017-08-06 02:51:01.0</updated>
      <external_id nil="true"></external_id>
      <standard_fields/>
      <custom_fields/>
    </contact>
    <timestamp>2023-09-14 20:27:36</timestamp>
    <mailing_id>4281</mailing_id>
    <reason>custom_property</reason>
    <reason_details>notexist</reason_details>
  </filtered_contact>
  ...
<filtered_contacts>
Inhaltsverzeichnis