Skip to content

Update event names #825

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

Merged
merged 1 commit into from
Jun 18, 2025
Merged

Update event names #825

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 21 additions & 24 deletions integrations/analytics/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -576,28 +576,25 @@ The syntax for `docs.json` is below. You only need to include entries for the pl
```
## Analytics events

We send the following events to your analytics provider.
We send the following events to your analytics provider. All events use the `docs.` prefix.

| Event name | Description |
|:-----------------------------------|:-------------------------------------------------------------------|
| `accordion_close` | When a user closes an accordion. |
| `accordion_open` | When a user opens an accordion. |
| `api_playground_call` | When a user calls an API in the API playground. |
| `code_block_copy` | When a user copies code from a code block. |
| `cta_click` | When a user clicks a call to action. |
| `expandable_close` | When a user closes an expandable. |
| `expandable_open` | When a user opens an expandable. |
| `header_nav_item_click` | When a user clicks a header navigation item. |
| `pageview` | When a user views a page. |
| `powered_by_mintlify_click` | When a user clicks the "Powered by Mintlify" link. |
| `scroll_to_bottom` | When a user scrolls to the bottom of a page. |
| `thumb_vote` | When a user votes (thumbs up or down) on a page. |
| `ai_chat_citation_click` | When a user clicks a citation in a chat. |
| `ai_chat_feedback_positive_click` | When a user clicks the positive feedback button in a chat. |
| `ai_chat_feedback_negative_click` | When a user clicks the negative feedback button in a chat. |
| `chat_completed` | When a chat session is completed. |
| `chat_enter` | When a user initiates a chat. |
| `chat_followup` | When a user sends a follow up message. |
| `chat_shared` | When a user shares a chat conversation. |
| `search_close` | When a user closes the search bar. |
| `search_result_click` | When a user clicks a search result. |
| Event name | Description |
|:---------------------------------------|:--------------------------------------------------------------------|
| `docs.accordion.close` | When a user closes an accordion. |
| `docs.accordion.open` | When a user opens an accordion. |
| `docs.api_playground.request` | When a user calls an API in the API playground. |
| `docs.code_block.copy` | When a user copies code from a code block. |
| `docs.code_block.ask_ai` | When a user asks the assistant to explain a code block. |
| `docs.navitem.cta_click` | When a user clicks a call to action. |
| `docs.expandable.close` | When a user closes an expandable. |
| `docs.expandable.open` | When a user opens an expandable. |
| `docs.navitem.click` | When a user clicks a header navigation item. |
| `docs.footer.powered_by_mintlify_click` | When a user clicks the "Powered by Mintlify" link. |
| `docs.assistant.source_click` | When a user clicks a citation in a chat. |
| `docs.assistant.thumbs_up` | When a user clicks the positive feedback button in a chat. |
| `docs.assistant.thumbs_down` | When a user clicks the negative feedback button in a chat. |
| `docs.assistant.completed` | When a chat session is completed. |
| `docs.assistant.enter` | When a user initiates a chat. |
| `docs.assistant.shared` | When a user shares a chat conversation. |
| `docs.search.close` | When a user closes the search bar. |
| `docs.search.result_click` | When a user clicks a search result. |