Skip to main content
For a full list of your User / Company Properties see the Properties API
The Chameleon User Profiles API allows you to:
  • Create / Update custom User properties
  • Retrieve a user by id, uid and email.
  • Search for users or get the count of users using any of the properties you have sent to us.
  • Clear or reset a specific user’s data.
  • Delete a user permanently

​
Schema

​
Fully-expanded profile when listed directly or embedded with expand param specified properly

PropertyTypeDescription
idIDThe Chameleon ID
created_attimestampWhen this happened or when this was added to the Database
updated_attimestampThe last time any property was updated
uidstringThe external ID that came from your backend system
company_idIDThe Chameleon ID of the Company (only if associated)
browser_xnumberBrowser width in pixels
browser_tznumberBrowser timezone in integer offset (+/-) from UTC
browser_lstringLanguage code as reported by the Accept-Language header
browser_nstringBrowser name: One of chrome, firefox, safari, opera, ie10, ie11, or edge
browser_kstringBrowser kind: One of desktop or mobile
percentnumberRandomly assigned but stable, used for A/B testing
last_seen_attimestampWhen the user was las active on a page where Chameleon is installed
last_seen_session_countnumberNumber of sessions specified as a period of inactivity of last_seen_at of greater than 90 minutes
delivery_idsarray<ID>Ordered list of Delivery model IDs
companyobjectThe expandable Company (only if associated)
*any optionsmixedAny other options you have sent as Custom Properties will show up here too

​
Non-expanded profile when embedded in another (i.e. Microsurvey response)

PropertyTypeDescription
idIDThe Chameleon ID
created_attimestampWhen this happened or when this was added to the Database
updated_attimestampThe last time any property was updated
uidstringThe external ID that came from your backend system

​
Create or Update a User

See the User Profiles Webhook for sending User data to Chameleon

​
Retrieve a specific User

​
HTTP Request

GET|POST https://api.chameleon.io/v3/analyze/profiles/:id
GET|POST https://api.chameleon.io/v3/analyze/profile # singular with parameters
param-description
idoptionalThe Chameleon ID of the User Profile
uidoptionalThe User Profile identifier (typically the Database ID from your backend)
emailoptionalIf you have sent an email address, this will be available for single-user lookup
Only one of these parameters is required. Users matched are uniquely identified based on these keys (no two users have the same uid or email) When using a GET request with parameters: 
?id=5f3c4232c712de665632a6d5
?uid=18821
[email protected]
When using a POST request send one of these properties: 
{
  "id": "5f3c4232c712de665632a6d5",
  "uid": 18821,
  "email": "[email protected]"
}

​
HTTP Response

{
  "profile": {
    "id": "5f3c4232c712de665632a6d5",
    "uid": 18821,
    "email": "[email protected]",
    "first_name": "Leon",
    "role": "admin",
    "last_import_at": "2029-04-07T12:18:00Z",
    "invited_users_count": 4,
     ...
  }
}

​
Clear or Reset a User Profile

Clearing a profile consists of:
  • Resetting the properties such as browser width, last seen time, sessions count, etc..
  • Removing Microsurvey responses.
  • Reverts summary data from any actions this user took (i.e. Tour Started counts decremented appropriately).
  • Removes and resets any Events that were tracked for this user.
  • A new percent is assigned and last_cleared_at is updated to "$now".
  • A few other internal cleanup items.
It is also possible to clear a user profile through the Chameleon Dashboard but is limited to profiles associated with the currently logged-in Chameleon Admin. To clear any profile on your account use this API.

​
HTTP Request

DELETE https://api.chameleon.io/v3/edit/profiles/:id
# OR
DELETE https://api.chameleon.io/v3/edit/profiles?uid=:uid
param-description
idoptionalA Chameleon User Profile ID to lookup
uidoptionalThe User Profile Identifier (typically the Database ID from your backend)

​
HTTP Response

{
  "profile": {
    "id": "5f3c4232c712de665632a6d5",
    "uid": 18821,
    "last_cleared_at": "2029-04-07T12:18:00Z",
    "browser_x": null,
    "last_seen_at": null,
    "percent": 12.231,
     ...
  }
}

​
Delete a User Profile permanently

The ability to delete a User Permanently is part of our effort to allow your users to opt-out of continued data storage by Chameleon and its partners. The key actions taken directly after deleting a User, is to remove Associated data before then removing the User profile data. Associated data includes records of Chameleon Experiences, Events logged and any other internal metrics associated with actions the user has taken. At the end of the process no record of this user exists in our database. Additionally, any data stored in backups relating to user profile data in our database has a retention of 3 months.

​
HTTP Request

DELETE https://api.chameleon.io/v3/edit/profiles/:id/forget
# OR
DELETE https://api.chameleon.io/v3/edit/profiles/forget?uid=:uid
param-description
idoptionalA Chameleon User Profile ID to remove
uidoptionalThe User Profile Identifier (typically the Database ID from your backend)
emailoptionalIf you have sent an email address, this will be available for single-user lookup

​
HTTP Response

The Deletion is an internal Chameleon record that can be referenced as proof of initiating this request. 
{
  "profile": {
    "id": "5f3c4232c712de665632a6d5",
  },
  "deletion": {
    "id": "5f3c4232c712de665632a6d6",
  }
}

​
Delete many User Profiles

Please use this gist to delete users via a CSV!