v1

latestOpenAPI 3.0.32026-07-22177397578.0 KB
Visit

Get visitor data

Returns the activity feed for a visitor. Use this to retrieve visit data Kameleoon collected, such as triggered experiments, personalizations, or targeted segments.

get/visit/visitor

Query parameters

siteCodestring required

The Kameleoon project ID.

currentVisitboolean

Set to <code>true</code> to get data for the current visit. Note: It is strongly recommended to provide the <code>visitorCode</code> parameter. If not, Kameleoon uses the last visitor code associated with the provided <code>mappingValue</code> to retrieve the visit.

maxNumberPreviousVisitsinteger required

The maximum number of previous visits to return. Note: If you provide the <code>mappingValue</code> parameter, Kameleoon performs cross-device reconciliation of previous visits. Otherwise, Kameleoon uses the provided <code>visitorCode</code>.

visitorCodestring

The visitor code (a unique Kameleoon ID for a visitor). Note: This is required if you do not provide the <code>mappingValue</code> parameter.

mappingValuestring

The value of the custom data configured as a mapping identifier (acts as a cross-device ID). Note: This is required if you do not provide the <code>visitorCode</code> parameter.

allboolean

Set to <code>true</code> to get all available data for a visitor.

staticDataboolean

Set to <code>true</code> to get static data events (browser, browser version, device type, OS) for a visitor. Note: Kameleoon ignores this if the <code>all</code> parameter is <code>true</code>.

pageboolean

Set to <code>true</code> to get page data events (URLs viewed) for a visitor. Note: Kameleoon ignores this if the <code>all</code> parameter is <code>true</code>.

conversionboolean

Set to <code>true</code> to get conversion events for a visitor for goals you have set up in your Kameleoon account. Note: Kameleoon ignores this if the <code>all</code> parameter is <code>true</code>.

targetingSegmentboolean

Set to <code>true</code> to get targeted segment IDs for a visitor. Note: This requires the Kameleoon Audiences Explorer add-on or the Kameleoon AI-Driven Personalization package. Kameleoon ignores this if the <code>all</code> parameter is <code>true</code>.

experimentboolean

Set to <code>true</code> to get targeted experiment IDs and variation IDs for a visitor. Note: Kameleoon ignores this if the <code>all</code> parameter is <code>true</code>.

weatherboolean

Set to <code>true</code> to get weather conditions data (temperature, humidity, pressure...) collected by Kameleoon. Note: Kameleoon ignores this if the <code>all</code> parameter is <code>true</code>.

customDataboolean

Set to <code>true</code> to get custom data events for a visitor. Note: You can only retrieve custom data not set as "local". Kameleoon ignores this if the <code>all</code> parameter is <code>true</code>.

productboolean

Set to <code>true</code> to get product events (product EANs viewed) for a visitor. Note: Kameleoon ignores this if the <code>all</code> parameter is <code>true</code>.

personalizationboolean

Set to <code>true</code> to get the targeted personalization IDs and variation IDs for a visitor. Note: Kameleoon ignores this if the <code>all</code> parameter is <code>true</code>.

geolocationboolean

Set to <code>true</code> to get geolocation data (country, region, city, postal code, latitude...) for a visitor. Note: Kameleoon ignores this if the <code>all</code> parameter is <code>true</code>.

prettyPrintboolean

Set to <code>true</code> for a "pretty" printed response.

Headers

user-agentstring required

Not always required. Kameleoon rejects an incoming request if the source is a bot or spider, based on IAB/ABC user-agent filtering rules. Kameleoon uses a single-pass method. You don't need to take specific action when sending requests from a web browser using a standard library (XHR). However, in other cases, set a custom value for the User-Agent request header to overwrite the default value the library sets.

Response

Successful operation, youngest visits are rendered, of type JSON object {"currentVisit": <current visit>, "previousVisits": <previous visits>}, with <current visit> of type <visit>, <previous visits> of type JSON array of <visit> and with <visit> = JSON object ("currentVisit" optional key)