Skip to main content
With the Chameleon API, you can list Tour Interactions that follow the specified parameters.

​
Schema

PropertyTypeDescription
idIDThe Chameleon ID
created_attimestampWhen this happened or when this was added to the Database
updated_attimestampThe last time any property was updated
statestringThe current state of this Tour Interaction: One of started, completed, exited, or displayed
tour_idIDThe Chameleon ID of the Tour
group_idIDThe Chameleon ID of the parent Experience that triggered this Tour Interaction to begin (Launcher, Tour etc.)
group_kindstringThe kind of parent Experience that triggered this Tour Interaction to begin: One of link, api_js, launcher, experiment, or campaign
defer_countnumberThe number of times this Tour was snoozed until later
defer_untilnoneThe timestamp of when the snoozed ends
goal_attimestampThe timestamp of when the configured Goal was met
profileobjectAn expandable Profile model
profile.companynoneAn expandable Company model embedded in the profile

​
List Tour Interactions

​
HTTP Request

GET  https://api.chameleon.io/v3/analyze/interactions
param-description
idrequiredThe Chameleon ID of the Tour
limitoptionalDefaults to 50 with a maximum of 500
beforeoptionalUsed when paginating, use directly from the cursor object from the previous response
beforeoptionalRead as “created before” and can be given as a timestamp to get only limit items that were created before this time
afteroptionalRead as “created after” and can be given as a timestamp or ID to get only limit items that were created after this time
orderoptionalOne of created_at or updated_at. Defaults to created_at (the ID encodes this information).
expandoptionalObject that specifies relationships to include/exclude. Supported keys are profile and company
expand.profileoptionaluse values of all, min or skip to control the properties present in the profile. Defaults to min
expand.companyoptionaluse values of all, min or skip to control the properties present in the company. Defaults to min

​
Using the expand parameter

# As a URL parameter
expand[profile]=all&expand[company]=skip

# In the Reqeust body
{"expand":{"profile":"all","company":"skip"}}
Notes:
  • A profile key will always be present with an object value. The company (embedded within profile) will be missing when the User Profile is not attached to a Company, otherwise it will be an object.
  • The combination of before and after can be used to limit pagination to “stop” at your most recently cached Tour Interaction (send the max ID from your last import as the after parameter).

​
HTTP Response

{
  "interactions": [
    {
      "id": "5f3c4232c712de665632a6d5",
      "updated_at": "2029-04-07T11:18:00Z",
      "tour_id": "5f3c4232c712de665632a6d6",
      "state": "completed",
      "goal_at": "2029-04-07T12:18:00Z",
      "profile": {
        "id": "5f3c4232c712de665632a6d5",
        "uid": "55232",
        ...
      },
      ...
    },
    {
      "id": "5f3c4232c712de665632a2a3",
      "updated_at": "2029-04-07T11:18:00Z",
      "tour_id": "5f3c4232c712de665632a6d6",
      "state": "started",
      "goal_at": "2029-04-07T12:18:00Z",
      "profile": {
        "id": "5f3c4232c712de665632a6d8",
        "uid": "55233",
        ...
      },
      ...
    },
    ...
  ],
  "cursor": {
    "limit": 50,
    "before": "5f3c4232c712de665632a2a3"
  }
}