Skip to content

Update Tooltip API documentation with analytics data #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pulkitagrawal wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update Tooltip API documentation with analytics data #58

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81259a9
Update Tooltip API documentation with analytics data
pulkitagrawal Sep 1, 2025
894392b
Remove engagement_options from Tooltip API documentation
pulkitagrawal Sep 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions docs/apis/tooltips.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ 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`.
- Retrieve a single Tooltip based on the `id`, including analytics data such as view counts and engagement metrics.


## Schema :id=schema
Expand All @@ -31,6 +31,9 @@ With the Chameleon API for Tooltips, you can:
| `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](apis/tags.md) attached to this model |
| `stats` | object | Aggregated statistics for this Tooltip (all-time) |
| `stats.started_count` | number | Number of your end-users who saw this Tooltip |
| `stats.last_started_at` | timestamp | Most recent time any user saw this Tooltip |


## List Tooltips :id=tooltips-index
Expand Down Expand Up @@ -147,9 +150,15 @@ GET https://api.chameleon.io/v3/edit/tooltips/:id
"tooltip": {
"id": "5f3c4232c712de665632a2a1",
"name": "Admin Self-serve menu",
"style": "auto",
"position": 0,
"published_at": "2029-04-07T12:38:00Z",
"created_at": "2029-04-01T10:15:00Z",
"updated_at": "2029-04-07T12:38:00Z",
"tag_ids": [],
"stats": {
"started_count": 124,
"last_started_at": "2029-04-07T11:45:00Z"
},
...
}
}
Expand Down