Skip to content

feat: add 4 more events for actions in context menu #1025

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
Aug 13, 2025
Merged

feat: add 4 more events for actions in context menu #1025

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
63 changes: 37 additions & 26 deletions integrations/analytics/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,14 @@ Automatically send data about your documentation engagement to your third party
viewBox="0 0 97 97"
fill="none"
>
<path d="M33 3.75C33 2.7835 33.7835 2 34.75 2H93.25C94.2165 2 95 2.7835 95 3.75V62.25C95 63.2165 94.2165 64 93.25 64H33V3.75Z" className="fill-black dark:fill-white"/>
<path d="M33 93.25C33 94.2165 32.2165 95 31.25 95L3.75 95C2.7835 95 2 94.2165 2 93.25L2 65.75C2 64.7835 2.7835 64 3.75 64L33 64L33 93.25Z" className="fill-black dark:fill-white"/>
<path
d="M33 3.75C33 2.7835 33.7835 2 34.75 2H93.25C94.2165 2 95 2.7835 95 3.75V62.25C95 63.2165 94.2165 64 93.25 64H33V3.75Z"
className="fill-black dark:fill-white"
/>
<path
d="M33 93.25C33 94.2165 32.2165 95 31.25 95L3.75 95C2.7835 95 2 94.2165 2 93.25L2 65.75C2 64.7835 2.7835 64 3.75 64L33 64L33 93.25Z"
className="fill-black dark:fill-white"
/>
</svg>
}
/>
Expand Down Expand Up @@ -597,31 +603,36 @@ 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. All events use the `docs.` prefix.

| 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.content.view` | When a user views a page. Only available for analytics providers that do not track page views by default. |
| `docs.feedback.thumbs_up` | When a user clicks the positive feedback button. |
| `docs.feedback.thumbs_down` | When a user clicks the negative feedback button. |
| `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.suggestion_click` | When a user clicks a suggestion 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. |
| 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.content.view` | When a user views a page. Only available for analytics providers that do not track page views by default. |
| `docs.feedback.thumbs_up` | When a user clicks the positive feedback button. |
| `docs.feedback.thumbs_down` | When a user clicks the negative feedback button. |
| `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.suggestion_click` | When a user clicks a suggestion 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. |
| `docs.context_menu.copy_page` | When a user copies the current page as markdown. |
| `docs.context_menu.copy_mcp_link` | When a user copies the hosted MCP server link. |
| `docs.context_menu.ai_provider_click` | When a user clicks an AI provider and create a conversation with current page as context. |
| `docs.context_menu.install_mcp_server` | When a user installs the hosted MCP server on code editors. |