Returns a page of unsubscriptions.
1 |
GET https://api.maileon.com/1.0/reports/unsubscriptions/reasons |
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 | |
order | count | The order of results. Possible values are: “count” or “name”. |
asc | true | Describes if results will be ordered ascending (true) or descending (false). |
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
Attributes | Optional | Description |
unsubscription_reasons | false | The wrapper structure for a list of unsubscribe_reasons |
unsubscription_reason | false | The wrapper structure of a single unsubscription reason |
reason | true | The reason, can be one of
or a custom reason. |
count | true | Te count how often this reason was counted. |
Example
1 2 3 |
GET https://api.maileon.com/1.0/reports/unsubscriptions/reasons?page_index=1&page_size=10 Authorization: Basic XXXXXXXXXXXXXXX Accept: application/vnd.maileon.api+xml; charset=utf-8 |
1 2 3 4 5 |
Status: 200 OK Content-Type: application/vnd.maileon.api+xml Link: ... X-Pages: ... X-Items: ... |
1 |
<unsubscription_reasons><unsubscription_reason><reason>no_demand</reason><count>1</count></unsubscription_reason></unsubscription_reasons> |