API
Kliks ophalen
Dit voorbeeld laat zien hoe je de kliks van één of meerdere statistieken kunt ophalen.
Parameters
| Veld | Type | Omschrijving | Verplicht / Optioneel |
|---|---|---|---|
statids | string | Komma-gescheiden id's van statistieken. | Verplicht |
order_by | string | Op welke volgorde de kliks in de array gesorteerd moeten zijn (emailaddress, opentime). | Optioneel |
order_dir | string | Of de sortering van laag naar hoog of andersom moet worden gedaan (ASC of DESC). | Optioneel |
count_only | string | Of alleen het aantal moet worden teruggegeven. Default: false. | Optioneel |
linkid | string | Het id van de specifieke link waarvan je het aantal kliks wilt weten. Default: a (all). | Optioneel |
linkid.DateClickedSearch | De parameter voor het zoeken op datum. | Verplicht | |
linkid.DateClickedSearch.filter | string | Deze moet op 1 staan om te kunen filteren | Optioneel |
linkid.DateClickedSearch.type | string | Dit kan zijn before, after, exact(ly), between, notbetween en not. | Optioneel |
linkid.DateClickedSearch.StartDate | string | De unix timestamp van de begindatum waarop moet worden gezocht. | Optioneel |
linkid.DateClickedSearch.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 |
start | int | Geef het getal vanaf welk punt het resultaat moet worden teruggegeven. Default: 0 (eerste resultaat). | Optioneel |
perpage | string | Het aantal kliks dat per result moet worden teruggeven. Kies 'all' voor alle kliks. Default: 10 | Optioneel |
Succesvolle response
| Veld | Type | Omschrijving |
|---|---|---|
status | string | De waarde van het status-veld wordt als “SUCCESS” teruggeven bij een succesvolle respons. |
data | array | Indien de kliks 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>GetClicks</requestmethod>
<responsetype>xml</responsetype>
<details>
<statids>99</statids>
<order_by>opentime</order_by>
<order_dir>desc</order_dir>
<linkid>a</linkid>
<count_only>false</count_only>
<searchinfo>
<DateClickedSearch>
<filter>1</filter>
<type>between</type>
<StartDate>1662917256</StartDate>
<EndDate>1726075656</EndDate>
</DateClickedSearch>
</searchinfo>
<start>0</start>
<perpage>10</perpage>
</details>
</xmlrequest>