Dit voorbeeld laat zien hoe je de opens van één of meerdere statistieken kunt ophalen.

Parameters

Parameters
VeldTypeOmschrijvingVerplicht / Optioneel
statidsstring

Komma-gescheiden id's van statistieken.

Verplicht
order_bystring

Op welke volgorde de opens in de array gesorteerd moeten zijn (emailaddress, opentime).

Optioneel
order_dirstring

Of de sortering van laag naar hoog of andersom moet worden gedaan (ASC of DESC).

Optioneel
countonlystring

Of alleen het aantal moet worden teruggegeven. Default: false.

Optioneel
only_uniquestring

Of alleen de unieke opens moeten worden teruggegeven. Default: a.

Optioneel
only_unique.DateOpenedSearch

De parameter voor het zoeken op datum.

Verplicht
only_unique.DateOpenedSearch.filterstring

Deze moet op 1 staan om te kunen filteren

Optioneel
only_unique.DateOpenedSearch.typestring

Dit kan zijn before, after, exact(ly), between, notbetween en not.

Optioneel
only_unique.DateOpenedSearch.StartDatestring

De unix timestamp van de begindatum waarop moet worden gezocht.

Optioneel
only_unique.DateOpenedSearch.EndDatestring

De unix timestamp van de einddatum waarop moet worden gezocht. Deze geef je alleen op als bij type is gekozen voor between of notbetween

Optioneel
startint

Geef het getal vanaf welk punt het resultaat moet worden teruggegeven. Default: 0 (eerste resultaat).

Optioneel
perpagestring

Het aantal opens dat per result moet worden teruggeven. Kies 'all' voor alle opens. Default: 10

Optioneel

Succesvolle response

Succesvolle response
VeldTypeOmschrijving
statusstring

De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons.

dataarray

Indien de opens worden gevonden wordt het object teruggegeven.

Foutmelding

Foutmelding
VeldTypeOmschrijving
statusstring

De waarde van het status-veld zal “FAILED” zijn.

errormessagestring

Een tekstuele boodschap om uit te leggen waarom het verzoek is mislukt.

Request voorbeeld
<xmlrequest>
	<username>admin</username>
	<usertoken>0123456789abcdef0123456789abcdef01234567</usertoken>
	<requesttype>stats</requesttype>
	<requestmethod>GetOpens</requestmethod>
	<responsetype>xml</responsetype>
	<details>
		<statids>99</statids>
		<order_by>opentime</order_by>
		<order_dir>desc</order_dir>
		<only_unique>false</only_unique>
		<count_only>false</count_only>
		<searchinfo>
			<DateOpenedSearch>
				<filter>1</filter>
				<type>between</type>
				<StartDate>1662917256</StartDate>
				<EndDate>1726075656</EndDate>
			</DateOpenedSearch>
		</searchinfo>
		<start>0</start>
		<perpage>10</perpage>
	</details>
</xmlrequest>