API

Nieuwsbrief statistieken (meerdere)

Dit voorbeeld laat zien hoe je de statistieken verschillende campagnes kunt ophalen.

Parameters

Parameters
VeldTypeOmschrijvingVerplicht / Optioneel
usernamestring

De gebruikersnaam wordt gebruikt om in te loggen op de MailCamp.

Verplicht
usertokenstring

De unieke token toegewezen aan de hierboven genoemde gebruiker.

Verplicht
requesttypestring

De naam van het betreffende API-bestand.

Verplicht
requestmethodstring

De naam van de functie die wordt aangeroepen.

Verplicht
details

Zie de velden hieronder.

Verplicht
listidsint

De kommagescheiden IDs van de mailinglijsten waarvan je de verzendstatistieken wilt ophalen. 'all' is voor statistieken van alle lijsten.

Verplicht
sortinfoint

Zie de velden hieronder.

Optioneel
sortinfo.SortBystring

Op welke volgorde de statistieken in de array gesorteerd moeten zijn (starttime, finishtime).

Optioneel
sortinfo.Directionstring

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
startint

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

Optioneel
perpagestring

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

Optioneel
newsletteridint

Het ID van de nieuwsbrief waarvan je de verzendstatistieken wilt ophalen.

Optioneel
newsletterid.DateSentSearch

Het ID van de mailinglijst waarop de contactpersoon staat.

Verplicht
newsletterid.DateSentSearch.filterstring

Deze moet op 1 staan om te kunen filteren

Optioneel
newsletterid.DateSentSearch.typestring

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

Optioneel
newsletterid.DateSentSearch.StartDatestring

De unix timestamp van de begindatum waarop moet worden gezocht.

Optioneel
newsletterid.DateSentSearch.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
useridint

Het ID van de gebruiker waarvan je de verzendstatistieken wilt ophalen. Deze kun je alleen met een admin api token configureren

Optioneel
typestring

Hier kun je kiezen tussen newsletter, splittest of all (allemaal). Default: newsletter

Optioneel

Succesvolle response

Succesvolle response
VeldTypeOmschrijving
statusstring

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

dataint

Indien de statistieken 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>GetNewsletterStats</requestmethod>
	<responsetype>xml</responsetype>
	<details>
		<listids>99</listids>
		<newsletterid>99</newsletterid>
		<sortinfo>
			<SortBy>finishdate</SortBy>
			<Direction>desc</Direction>
		</sortinfo>
		<searchinfo>
			<DateSentSearch>
				<filter>1</filter>
				<type>between</type>
				<StartDate>1662917256</StartDate>
				<EndDate>1726075656</EndDate>
			</DateSentSearch>
		</searchinfo>
		<start>0</start>
		<perpage>all</perpage>
		<type>newsletter</type>
	</details>
</xmlrequest>