Die Data API von Kameleoon ist eine REST-API, die mehrere Funktionen bietet, darunter das Speichern und Abrufen von Daten zu externen Benutzern und die Verwaltung von Offline-Konversionen für Ziele. Verwenden Sie die Data API, um festzustellen, ob Kameleoon Besuchsereignisse erhalten hat, die automatisch von Kameleoon oder über Methoden der Activation API oder des SDK gesendet wurden. Dieser Artikel erklärt, wie der GET visit/visitor-Endpoint der Data API verwendet wird, um zu überprüfen, ob bestimmte Ereignistypen von Kameleoon eingelesen wurden. Diese Überprüfung ist besonders nützlich beim Testen von Tracking-Code. Die folgenden Abschnitte erläutern, wie diese Ereignisse programmatisch überprüft werden:
Ereignisparameter
Wie oben erwähnt, müssen alle Anfragen an den GET visit/visitor-Endpoint der Data API gerichtet werden.
Zu den Standardparametern für Anfragen zu Experiment-Exposition, Custom Data und Konversionsereignissen gehören:
Entweder:
- visitorCode (string): Kameleoons eindeutige ID für einen Besucher. Erforderlich, wenn
mappingValue nicht angegeben wird.
ODER
-
mappingValue (string): Wert der als Mapping-Identifikator konfigurierten Custom Data (fungiert als geräteübergreifende Besucher-ID), falls zutreffend. Erforderlich, wenn
visitorCode nicht angegeben wird.
-
siteCode (string): Eine eindeutige Zeichenfolge aus Buchstaben und Zahlen, die ein Kameleoon-Projekt identifiziert. Rufen Sie diesen Code über diesen Link ab.
-
currentVisit (string | optional): Auf
true setzen, um Daten zu aktuellen Besuchen zu erhalten. Nur Benutzer, die Feature Experimentation verwenden, können Daten für aktive Besuche anfordern.
-
Je nach dem spezifisch angefragten Ereignis muss jede Anfrage einen zusätzlichen booleschen Parameter enthalten, der auf
true gesetzt ist: entweder experiment, customdata oder conversion, wie in den folgenden Beispielen gezeigt.
Ereignisanfragen
Nachfolgend finden Sie Beispiele für das Format, das für Anfragen und Antworten verwendet wird, spezifisch für jedes Ereignis:
Für eine benutzerfreundlichere Ausgabe fügen Sie den Parameter prettyPrint=true in den Anfrage-Header ein.
Experiment-Exposition
Anfrage
curl -X GET 'https://eu-data.kameleoon.io/visit/visitor?siteCode=f17c21u1ag&visitorCode=245fc¤tVisit=true&maxNumberPreviousVisits=20&experiment=true'
Antwort
{
"previousVisits": [
{
"siteCode": "f17c21u1ag",
"visitorCode": "245fc",
"timeStarted": 1748912914969,
"timeLastEvent": 1748912914969,
"experimentEvents": [
{
"itp": false,
"tabId": -218793282,
"time": 1748977476606,
"data": {
"id": 250830,
"variationId": 978588
}
}
]
}
]
}
In der Beispielantwort repräsentiert id die ID des Experiments, während variationId die spezifische Variation des Experiments ist, der der Besucher ausgesetzt ist.
Custom Data
Anfrage
curl -X GET 'https://eu-data.kameleoon.io/visit/visitor?siteCode=f17c21u1ag&visitorCode=245fc¤tVisit=true&maxNumberPreviousVisits=20&customdata=true'
Antwort
{
"previousVisits": [
{
"siteCode": "f17c21u1ag",
"visitorCode": "245fc",
"timeStarted": 1748912914969,
"timeLastEvent": 1748912914969,
"customDataEvents": [
"itp": false,
"tabId": 51426880,
"time": 1748978024982,
"data": {
"index": 1,
"valuesCountMap": {
"true":1
},
"overwrite": true,
"mappingIdentifier": false
},
"itp": false,
"tabId": 51426880,
"time": 1748978024982,
"data": {
"index": 3,
"valuesCountMap": {
"1": 1},
},
"overwrite": false,
"mappingIdentifier": false
]
}
]
}
In der Beispielantwort ist index die eindeutige ID der Custom Data.
Konversion
Anfrage
curl -X GET 'https://eu-data.kameleoon.io/visit/visitor?siteCode=f17c21u1ag&visitorCode=245fc¤tVisit=true&maxNumberPreviousVisits=20&conversion=true'
Antwort
{
"previousVisits": [
{
"siteCode": "f17c21u1ag",
"visitorCode": "245fc",
"timeStarted": 1748912914969,
"timeLastEvent": 1748912914969,
"conversionEvents": [
{
"itp": false,
"time": 1748912914969,
"data": {
"goalId": 361517,
"revenue": 23.5,
"negative": false,
"metadata": {}
}
}
]
}
]
}