+49 69 83008980 service@xqueue.com
Seite wählen
Benötigen Sie Hilfe?

Get Unsubscriptions

Sie sind hier:

Returns a page of unsubscriptions.

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

Attributes

Parameter Default Description
from_date If provided, only the unsubscriptions 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 unsubscriptions 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 unsubscriptions 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
source Filters the unsubscriptions by their source. The source can be an unsubscription link (link), a reply mail (reply) or other.
embed_transaction_id  false If the set to true, the attribut “transaction_id” of a transaction will be returned that caused this click, if available.
If this setting is set to true, it will add a ‘transaction_id’ element to the result.embed_contact_hashfalseIf 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 clicks from all clicks, even if contacts are unsubscribed and therefore anonymized. If in two clicks of the same sendout the contact hash is the same, then the same contact clicked twice.
In different mails the same contact hash might occur on a click 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.

Reply

Parameter Optional Description
contact false The available contact details, only the Maileon ID, the external ID and the Email-Address are available
timestamp false The timestamp of the unsubscription as yyyy-mm-dd hh:mm:ss
mailing_id true The ID of the mailing the unsubscription came from.
source false The source of the unsubscription. The following values are valid:

 – reply (the contact replied manually and wrote that he does not want to be subscribed any more)

 – link (the contact used the “unsubscription link” inside the email)

 – list-unsubscribe-header (the contact used a feature of its mail client that supports the list-unsubscribe feature, see http://www.list-unsubscribe.com/ )

 – complaint (when a contact registers a complaint, he will be unsubscribed automatically)

 – import (the contact was unsubscribed using the “import unsubscriber” funktion (e.g. over FTP)

 – contactsjob (contacts can also be unsubscribed on a regular base by a contact job, e.g. using some contact filter as selection criteria)

 – api (the unsubscription was triggered via the REST API)

 – manual (contact has been unsubscribed using the Maileon UI)

 – wa-action (if the user has been unsubscribed by a marketing automation program)

 – other (in unknown cases)

Example

GET https://api.maileon.com/1.0/reports/unsubscriptions?page_index=3&page_size=5
Authorization: Basic XXXXXXXXXXXXXXX
Accept: application/vnd.maileon.api+xml; charset=utf-8
Status: 200 OK
Content-Type: application/vnd.maileon.api+xml
Link: ...
X-Pages: ...
X-Items: ...

<!--?xml version="1.0" encoding="UTF-8"?-->
<unsubscriptions>
  <unsubscription>
    <contact anonymous="true">
      <id>5647</id>
      <external_id nil="true"></external_id>
      <email>...</email>
    </contact>
    <timestamp>2013-01-17 13:18:25</timestamp>
    <mailing_id>14</mailing_id>
    <source>link</source>
  </unsubscription>
...
</unsubscriptions>

 

Inhaltsverzeichnis