Skip to main content

GET /visit/visitor‚Äč

This endpoint returns the activity feed for a given user. It can be used to retrieve visits data collected by Kameleoon such as experiments and personalizations being triggered for the user or targeted segments.

Query Parameters
  • siteCode string required

    Id of the Kameleoon project

  • currentVisit boolean

    Set to true if you would like to get data for the current visit. Note: it requires parameter "visitorCode" being provided

  • maxNumberPreviousVisits int32 required

    The maximum number of previous visits to return

  • mappingValue string

    Value of the custom data configured as a mapping identifier (acting as a visitor cross-device id) if applicable. Note: it is required if parameter "visitorCode" is not provided

  • visitorCode string

    Visitor code (Kameleoon unique id for a visitor). Note: it is required if parameter "currentVisit" is set to true. It is required also if parameter "mappingValue" is not provided

  • all boolean

    Set to true if you would like to get all events (conversion, page, experiment, custom data..) for the given user

  • staticData boolean

    Set to true if you would like to get static data events (browser, browser version, device type, OS) for the given user. Note: it is ignored if parameter "all" is provided with value true

  • page boolean

    Set to true if you would like to get page data events (URLs viewed) for the given user. Note: it is ignored if parameter "all" is provided with value true

  • conversion boolean

    Set to true if you would like to get conversion events for the given user and for goals you have set up in your Kameleoon account. Note: it is ignored if parameter "all" is provided with value true

  • targetingSegment boolean

    Set to true if you would like to get the targeted segments id for a given user. Note: it requires Kameleoon Audiences Explorer add-on or Kameleoon AI-Driven Personalization package. It is ignored if parameter "all" is provided with value true

  • experiment boolean

    Set to true if you would like to get the targeted experiments id and variations id for a given user. Note: it is ignored if parameter "all" is provided with value true

  • weather boolean

    Set to true if you would like to get weather conditions data (temperature, humidity, pressure...) collected by Kameleoon. Note: it is ignored if parameter "all" is provided with value true

  • customData boolean

    Set to true if you would like to get custom data events for a given user. Note: only custom data that are not set as "local" can be retrieved. It is ignored if parameter "all" is provided with value true

  • product boolean

    Set to true if you would like to get product events (product eans viewed) for a given user. Note: it is ignored if parameter "all" is provided with value true

  • personalization boolean

    Set to true if you would like to get the targeted personalizations id and variations id for a given user. Note: it is ignored if parameter "all" is provided with value true

  • geolocation boolean

    Set to true if you would like to get the geolocation data (country, region, city, postalcode, lattitude..) for a given user. Note: it is ignored if parameter "all" is provided with value true

  • prettyPrint boolean

    Set to true if you would like a "pretty" printed response

Responses

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

Loading...