API

Get unsubscribes

This example shows how you can retrieve the unsubscribes of one or more statistics.

Parameters

Parameters
Field	Type	Description	Required / Optional
`statids`	string	Comma-separated IDs of statistics.	Required
`listid`	int	If you want to retrieve the unsubscribes of a specific list. The statids parameter is ignored here.	Optional
`order_by`	string	The order in which the unsubscribes in the array must be sorted (emailaddress, unsubscribetime).	Optional
`order_dir`	string	Whether sorting must be from low to high or the other way around (ASC or DESC).	Optional
`count_only`	string	Whether only the count must be returned. Default: false.	Optional
count_only.`DateUnsubscribedSearch`		The parameter for searching by date.	Required
count_only.DateUnsubscribedSearch.`filter`	string	This must be 1 in order to filter	Optional
count_only.DateUnsubscribedSearch.`type`	string	This can be before, after, exact(ly), between, notbetween and not.	Optional
count_only.DateUnsubscribedSearch.`StartDate`	string	The unix timestamp of the start date to search on.	Optional
count_only.DateUnsubscribedSearch.`EndDate`	string	The unix timestamp of the end date to search on. You only specify this if between or notbetween was chosen as the type	Optional
`start`	int	Enter the number from which point the result must be returned. Default: 0 (first result).	Optional
`perpage`	string	The number of unsubscribes to return per result. Choose 'all' for all unsubscribes. Default: 10	Optional

Successful response

Successful response
Field	Type	Description
`status`	string	The value of the status field is returned as “SUCCESS” on a successful response.
`data`	array	If the unsubscribes are found, the object is returned.

Error response

Error response
Field	Type	Description
`status`	string	The value of the status field will be “FAILED”.
`errormessage`	string	A text message explaining why the request failed.

Request example

PHP request example

Response Success

Response Failed

Request example

<xmlrequest>
	<username>admin</username>
	<usertoken>0123456789abcdef0123456789abcdef01234567</usertoken>
	<requesttype>stats</requesttype>
	<requestmethod>GetUnsubscribes</requestmethod>
	<responsetype>xml</responsetype>
	<details>
		<statids>99</statids>
		<order_by>unsubscribetime</order_by>
		<order_dir>desc</order_dir>
		<listid>99</listid>
		<count_only>false</count_only>
		<searchinfo>
			<DateUnsubscribedSearch>
				<filter>1</filter>
				<type>between</type>
				<StartDate>1662917256</StartDate>
				<EndDate>1726075656</EndDate>
			</DateUnsubscribedSearch>
		</searchinfo>
		<start>0</start>
		<perpage>10</perpage>
	</details>
</xmlrequest>