API
Nieuwsbrief statistieken (meerdere)
Dit voorbeeld laat zien hoe je de statistieken verschillende campagnes kunt ophalen.
Parameters
| Veld | Type | Omschrijving | Verplicht / Optioneel |
|---|---|---|---|
username | string | De gebruikersnaam wordt gebruikt om in te loggen op de MailCamp. | Verplicht |
usertoken | string | De unieke token toegewezen aan de hierboven genoemde gebruiker. | Verplicht |
requesttype | string | De naam van het betreffende API-bestand. | Verplicht |
requestmethod | string | De naam van de functie die wordt aangeroepen. | Verplicht |
details | Zie de velden hieronder. | Verplicht | |
listids | int | De kommagescheiden IDs van de mailinglijsten waarvan je de verzendstatistieken wilt ophalen. 'all' is voor statistieken van alle lijsten. | Verplicht |
sortinfo | int | Zie de velden hieronder. | Optioneel |
sortinfo.SortBy | string | Op welke volgorde de statistieken in de array gesorteerd moeten zijn (starttime, finishtime). | Optioneel |
sortinfo.Direction | string | Of de sortering van laag naar hoog of andersom moet worden gedaan (asc of desc). | Optioneel |
countonly | string | Of alleen het aantal moet worden teruggegeven. Default: false. | Optioneel |
start | int | Geef het getal vanaf welk punt het resultaat moet worden teruggegeven. Default: 0 (eerste resultaat). | Optioneel |
perpage | string | Het aantal statistieken dat per result moet worden teruggeven. Kies 'all' voor alle opens. Default: 10 | Optioneel |
newsletterid | int | 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.filter | string | Deze moet op 1 staan om te kunen filteren | Optioneel |
newsletterid.DateSentSearch.type | string | Dit kan zijn before, after, exact(ly), between, notbetween en not. | Optioneel |
newsletterid.DateSentSearch.StartDate | string | De unix timestamp van de begindatum waarop moet worden gezocht. | Optioneel |
newsletterid.DateSentSearch.EndDate | string | 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 |
userid | int | Het ID van de gebruiker waarvan je de verzendstatistieken wilt ophalen. Deze kun je alleen met een admin api token configureren | Optioneel |
type | string | Hier kun je kiezen tussen newsletter, splittest of all (allemaal). Default: newsletter | Optioneel |
Succesvolle response
| Veld | Type | Omschrijving |
|---|---|---|
status | string | De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons. |
data | int | Indien de statistieken worden gevonden wordt het object teruggegeven. |
Foutmelding
| Veld | Type | Omschrijving |
|---|---|---|
status | string | De waarde van het status-veld zal “FAILED” zijn. |
errormessage | string | Een tekstuele boodschap om uit te leggen waarom het verzoek is mislukt. |
<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>