+49 69 83008980 service@xqueue.com

Benötigen Sie Hilfe?

Get Opens

< Alle Themen

Returns a page of opens.

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

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

Attributes

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
format Filters the opens by format. Possible values are: html / text.
social_network Multivalued parameter to filter the opens by the social networks where they occurred.
device_type Multivalued parameter to filter the opens by device type. Possible values for device_type are: UNKNOWN / COMPUTER / TABLET / MOBILE
exclude_anonymous_opens true Supported values: true / false. If set to true, the blocks 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.
embed_contact_hash false If the set to true, anonymized contacts will be annotated with a random number that is the same for a contact within each sendout. With this flag, it is possible to calculate unique opens from all opens, even if contacts are unsubscribed and therefore anonymized. If in two opens of the same sendout the contact hash is the same, then the same contact opened twice.
In different mails the same contact hash might occur on an open but will most probably not belong to the same (anonymized) contact.
If this setting is set to true, it will add a ‘contact_hash’ 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.

Example

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

<opens>
   <open>
    <contact>
      <id>12345</id>
      <email>max.mustermann@xqueue.com</email>
      <external_id nil="true"></external_id>
      <standard_fields>
       <field>
        <name>FIRSTNAME</name>
        <value>Max</value>
       </field>
      </standard_fields>
      <custom_fields>
       <field>
        <name>COLOR</name>
        <value>BLUE</value>
       </field>
      </custom_fields>
    </contact>
    <timestamp>2013-04-09 11:26:17</timestamp>
    <mailing_id>4012</mailing_id>
    <format>html</format>
    <device_type>COMPUTER</device_type>
    <client>
      <os_name>WINDOWS_7</os_name>
      <os_group>WINDOWS</os_group>
      <browser>FIREFOX</browser>
      <browser_group>FIREFOX</browser_group>
      <browser_type>WEB_BROWSER</browser_type>
      <user_agent nil="true"></user_agent>
      <rendering_engine>GECKO</rendering_engine>
    </client>
  </open>
...
</opens>

 

Inhaltsverzeichnis

Bleiben Sie Up-to-Date und profitieren Sie von spannenden News und Aktionen.

Maileon ist ein Produkt der XQueue GmbH

Newsletter Pop-Up