...
...
Um Metriken gerätespezifisch oder sitzungsspezifisch aufzuzeichnen, kann über die API 'generateClientId' eine Client-ID erstellt und in allen API-Aufrufen optional übermittelt werden. Die Client-ID sollte in einem Cookie oder dem App-Speicher abgelegt und später wieder verwendet werden.
Beispiel:
/generateClientId
Response: 45bc2918-7151-4cb9-8ae9-5b39913af5fb (HTTP Code 200)
Über die API "impression" wird eine eindeutige Impression ID abgerufen. Als Parameter ist der Tracking-Client als 'trackingcode' und die Client-Version als 'version' zu übergeben. Optional kann eine 'clientid' übermittelt werden. Alle Parameter sind vom Typ 'string'.
Beispiel:
/impression?trackingcode=NWSRDR&version=1.50
Response: 56d2882f-68aa-43f6-8748-6c9e7e583ef5 (HTTP Code 200)
Einer bereits registrierten Impression kann über die API 'clientid4impression' nachträglich eine bereits vorhandene Client-ID aufgeprägt werden (zB. wenn sich der Anwender erst nachträglich anmeldet).
Beispiel:
/clientid4impression?clientid=45bc2918-7151-4cb9-8ae9-5b39913af5fb&impressionid=56d2882f-68aa-43f6-8748-6c9e7e583ef5
Response:(HTTP Code 200)
Nachdem eine Impression-ID registriert wurde, können dieser beliebig viele Events zugeordnet werden, also das eigentliche Tracking erfolgen. (zB. das Downloaden einer ePaper Ausgabe)
Die API 'event' akzeptiert optional eine JSON Struktur, mit der weitere Daten je Event fest gehalten werden können (also zB. das Datum und die jeweilige Ausgabe eines ePapers).
Beispiel:
/event?eventcode=APP-LAUNCH&impressionid=56d2882f-68aa-43f6-8748-6c9e7e583ef5
Response:(HTTP Code 200)
Optionale JSON struktur (HTTP PUT):
{
"array": true,
"bigDecimal": true,
"bigInteger": true,
"binary": true,
"boolean": true,
"containerNode": true,
"double": true,
"float": true,
"floatingPointNumber": true,
"int": true,
"integralNumber": true,
"long": true,
"missingNode": true,
"nodeType": "ARRAY",
"null": true,
"number": true,
"object": true,
"pojo": true,
"short": true,
"textual": true,
"valueNode": true
}