Tooltips

A specific element already present on the page (button, header, text field).
A Custom Icon that Chameleon adds to the page (beta or new label etc.)

To know more about Tooltips, feel free to visit our product documentation.

With the Chameleon API for Tooltips, you can:

List all the Tooltips that follow a specified set of parameters.
Retrieve a single Tooltip based on the id.

Schema

Property	Type	Description
`id`	ID	The Chameleon ID
`created_at`	timestamp	When this happened or when this was added to the Database
`updated_at`	timestamp	The last time any property was updated
`name`	string	The name given by an administrator of Chameleon
`position`	number	The order that these appear in lists (starting from 0)
`published_at`	timestamp	The time this was most recently published
`tag_ids`	array<ID>	The Chameleon IDs of the Tags attached to this model

List Tooltips

List all the Tooltips that follow a specified set of parameters.

HTTP Request

GET

https://api.chameleon.io/v3/edit/tooltips

param	-	description
`limit`	optional	Defaults to `50` with a maximum of `500`
`before`	optional	Used when paginating, use directly from the `cursor` object from the previous response
`before`	optional	Read as “created `before`” and can be given as a timestamp to get only `limit` items that were created before this time
`after`	optional	Read 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

{
  "tooltips": [
    {
      "id": "5f3c4232c712de665632a6d5",
      "name": "When Search is disabled",
      "position": 4,
      "published_at": "2029-04-07T12:18:00Z",
       ...
    },
    {
      "id": "5f3c4232c712de665632a2a1",
      "name": "Admin Self-serve menu",
      "position": 2,
      "published_at": null,
       ...
    },
    ...
  ],
  "cursor": {
    "limit": 50,
    "before": "5f3c4232c712de665632a2a1"
  }
}

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

HTTP Request

PATCH

https://api.chameleon.io/v3/edit/tooltips/:id

param	-	description
`id`	required	A Tooltip ID to update
`url_group_id`	optional	An Environments ID prefixed with `+` to add or or `-` to remove the Environment
`tag_id`	optional	A Tag ID prefixed with `+` to add or or `-` to remove the Tag
`published_at`	optional	The published time of this Tooltip (set to now to trigger a publish)

To Publish the Tooltip send the current timestamp in iso8601 format

{
  "published_at": "2029-04-07T12:18:00Z"
}

To Unpublish the Tooltip 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"
}

Retrieve a single Tooltip

HTTP Request

GET

https://api.chameleon.io/v3/edit/tooltips/:id

param	-	description
`id`	required	A Tooltip ID to lookup

{
  "tooltip": {
    "id": "5f3c4232c712de665632a2a1",
    "name": "Admin Self-serve menu",
    "style": "auto",
    "position": 0,
    "published_at": "2029-04-07T12:38:00Z",
    ...
  }
}

Getting Started

JavaScript API

Guides

Webhooks

REST API

Schema

List Tooltips

HTTP Request

HTTP Response

Update a Tooltip

HTTP Request

Retrieve a Tooltip

HTTP Request

​Schema

​List Tooltips

​HTTP Request

​HTTP Response

​Update a Tooltip

​HTTP Request

​Retrieve a Tooltip

​HTTP Request

Schema

List Tooltips

HTTP Request

HTTP Response

Update a Tooltip

HTTP Request

Retrieve a Tooltip

HTTP Request