Skip to main content
  • The current page URL matches.
  • Segmentation matches (User is the right person) - required but can be to match All Users.
  • Launcher menu Icon or Custom Icon must be clicked.
To know more about Launchers, feel free to visit our product documentation.
With the Chameleon API for Launchers, you can:
  • List all Launchers based on the specified set of parameters.
  • Retrieve a specific Launcher based on its id.

​
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
namestringThe name given by an administrator of Chameleon
titlestringThe display title
descriptionstringThe display description
presetstringThe preconfigured type: One of icon, element, icon_checklist, updates, or faqs
segment_idIDThe Chameleon ID of the configured Segment
published_attimestampThe time this was most recently published
tag_idsarray<ID>The Chameleon IDs of the Tags attached to this model
list_typestringIf this is a checklist or a normal list: One of default or checklist
search_placeholderstringSearch placeholder
quantifier_urlstringThis must match the current page URL [deprecated]
quantifier_urlsarrayList of URL matching conditions that must match the current page URL
quantifier_urls.urlnoneThe specific URL used in this matching condition
quantifier_urls.match_typenoneThe type of matching used. One of: simple, exact, regex, inverse_simple, or inverse_exact
trigger_textstringTrigger text
blocked_domainsstringDomains that, if matched, will make this now show
empty_state_contentstringMarkdown content to show when all items in the Launcher are completed/hidden
icon_sizestringIcon size
screen_positionstringScreen position: One of bottom_left or bottom_right
position_typestringPosition type: One of relative_to_screen or snap_to_element
triggerstringTrigger: One of click or hover
trigger_typestringTrigger type: One of custom_icon, element, icon_lightbulb, icon_question, icon_checklist, icon_signpost, icon_bell, or text
itemsarray<LauncherItem>An array of items that define the Launcher menu contents (see full schema below)
statsobjectAggregated statistics for this model (all-time)
stats.displayed_countnumberNumber of times the Launcher widget (icon) was shown to end-users
stats.last_displayed_attimestampMost recent time the Launcher widget (icon) was shown to end-users
stats.started_countnumberNumber of times the Launcher menu was opened by an end-user
stats.last_started_attimestampMost recent time the Launcher menu was opened by an end-user

​
Launcher Item 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
kindstringThe type of item this is: One of url, tour, survey, script, or divider
titlestringThe display title in the Launcher menu
descriptionstringThe display description in the Launcher menu
segment_idIDThe Chameleon ID of the configured Segment
urlstringThe URL to link to when `kind=url
campaign_idIDThe Chameleon ID of the Tour or Microsurvey referenced when kind=tour or kind=survey
scriptstringThe JavaScript code snippet to execute when this item is clicked by your end-user
hidebooleanWhether or not to remove this item from the list after clicked/completed

​
List Launchers

List all Launchers based on the specified set of parameters.

​
HTTP Request

GET https://api.chameleon.io/v3/edit/launchers
param-description
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

​
HTTP Response

{
  "launchers": [
    {
      "id": "5f3c4232c712de665632a6d5",
      "name": "Admin Onboarding checklist",
      "position": 1,
      "published_at": "2029-04-07T12:18:00Z",
       ...
    },
    {
      "id": "5f3c4232c712de665632a2a1",
      "name": "Admin Self-serve menu",
      "position": 0,
      "published_at": "2029-04-07T12:38:00Z",
       ...
    },
    ...
  ],
  "cursor": {
    "limit": 50,
    "before": "5f3c4232c712de665632a2a1"
  }
}

​
Update a Launcher

Update a single Launcher to change its properties or to Publish it.

​
HTTP Request

PATCH https://api.chameleon.io/v3/edit/launchers/:id
param-description
idrequiredA Launcher ID to update
url_group_idoptionalAn Environments ID prefixed with + to add or or - to remove the Environment
tag_idoptionalA Tag ID prefixed with + to add or or - to remove the Tag
published_atoptionalThe published time of this Launcher (set to now to trigger a publish)
To Publish the Launcher send the current timestamp in iso8601 format 
{
  "published_at": "2029-04-07T12:18:00Z"
}
To Unpublish the Launcher set the published_at to null 
{
  "published_at": null
}
To add the 5e3c4232c712de666d55632a Environment use a + prefix 
{
  "url_group_id": "+5e3c4232c712de666d55632a"
}
To remove the 5e3c4232c712de666d55632a Environment use a - prefix 
{
  "url_group_id": "-5e3c4232c712de666d55632a"
}

​
Filtering by Segment

See Listing Related models

​
Retrieve a Launcher

Retrieve a single Launcher.

​
HTTP Request

GET https://api.chameleon.io/v3/edit/launchers/:id
param-description
idrequiredA Launcher ID to lookup
{
  "launcher": {
    "id": "5f3c4232c712de665632a2a1",
    "name": "Admin Self-serve menu",
    "position": 0,
    "published_at": "2029-04-07T12:38:00Z",
    ...
  }
}