@@ -150,8 +150,14 @@ Automatically send data about your documentation engagement to your third party
150150 viewBox = " 0 0 97 97"
151151 fill = " none"
152152 >
153- <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" />
154- <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" />
153+ <path
154+ 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"
155+ className = " fill-black dark:fill-white"
156+ />
157+ <path
158+ 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"
159+ className = " fill-black dark:fill-white"
160+ />
155161 </svg >
156162 }
157163/>
@@ -597,31 +603,36 @@ The syntax for `docs.json` is below. You only need to include entries for the pl
597603 }
598604}
599605```
606+
600607## Analytics events
601608
602609We send the following events to your analytics provider. All events use the ` docs. ` prefix.
603610
604- | Event name | Description |
605- | :---------------------------------------| :--------------------------------------------------------------------|
606- | ` docs.accordion.close ` | When a user closes an accordion. |
607- | ` docs.accordion.open ` | When a user opens an accordion. |
608- | ` docs.api_playground.request ` | When a user calls an API in the API playground. |
609- | ` docs.code_block.copy ` | When a user copies code from a code block. |
610- | ` docs.code_block.ask_ai ` | When a user asks the assistant to explain a code block. |
611- | ` docs.content.view ` | When a user views a page. Only available for analytics providers that do not track page views by default. |
612- | ` docs.feedback.thumbs_up ` | When a user clicks the positive feedback button. |
613- | ` docs.feedback.thumbs_down ` | When a user clicks the negative feedback button. |
614- | ` docs.navitem.cta_click ` | When a user clicks a call to action. |
615- | ` docs.expandable.close ` | When a user closes an expandable. |
616- | ` docs.expandable.open ` | When a user opens an expandable. |
617- | ` docs.navitem.click ` | When a user clicks a header navigation item. |
618- | ` docs.footer.powered_by_mintlify_click ` | When a user clicks the "Powered by Mintlify" link. |
619- | ` docs.assistant.source_click ` | When a user clicks a citation in a chat. |
620- | ` docs.assistant.suggestion_click ` | When a user clicks a suggestion in a chat. |
621- | ` docs.assistant.thumbs_up ` | When a user clicks the positive feedback button in a chat. |
622- | ` docs.assistant.thumbs_down ` | When a user clicks the negative feedback button in a chat. |
623- | ` docs.assistant.completed ` | When a chat session is completed. |
624- | ` docs.assistant.enter ` | When a user initiates a chat. |
625- | ` docs.assistant.shared ` | When a user shares a chat conversation. |
626- | ` docs.search.close ` | When a user closes the search bar. |
627- | ` docs.search.result_click ` | When a user clicks a search result. |
611+ | Event name | Description |
612+ | :-------------------------------------- | :-------------------------------------------------------------------------------------------------------- |
613+ | ` docs.accordion.close ` | When a user closes an accordion. |
614+ | ` docs.accordion.open ` | When a user opens an accordion. |
615+ | ` docs.api_playground.request ` | When a user calls an API in the API playground. |
616+ | ` docs.code_block.copy ` | When a user copies code from a code block. |
617+ | ` docs.code_block.ask_ai ` | When a user asks the assistant to explain a code block. |
618+ | ` docs.content.view ` | When a user views a page. Only available for analytics providers that do not track page views by default. |
619+ | ` docs.feedback.thumbs_up ` | When a user clicks the positive feedback button. |
620+ | ` docs.feedback.thumbs_down ` | When a user clicks the negative feedback button. |
621+ | ` docs.navitem.cta_click ` | When a user clicks a call to action. |
622+ | ` docs.expandable.close ` | When a user closes an expandable. |
623+ | ` docs.expandable.open ` | When a user opens an expandable. |
624+ | ` docs.navitem.click ` | When a user clicks a header navigation item. |
625+ | ` docs.footer.powered_by_mintlify_click ` | When a user clicks the "Powered by Mintlify" link. |
626+ | ` docs.assistant.source_click ` | When a user clicks a citation in a chat. |
627+ | ` docs.assistant.suggestion_click ` | When a user clicks a suggestion in a chat. |
628+ | ` docs.assistant.thumbs_up ` | When a user clicks the positive feedback button in a chat. |
629+ | ` docs.assistant.thumbs_down ` | When a user clicks the negative feedback button in a chat. |
630+ | ` docs.assistant.completed ` | When a chat session is completed. |
631+ | ` docs.assistant.enter ` | When a user initiates a chat. |
632+ | ` docs.assistant.shared ` | When a user shares a chat conversation. |
633+ | ` docs.search.close ` | When a user closes the search bar. |
634+ | ` docs.search.result_click ` | When a user clicks a search result. |
635+ | ` docs.context_menu.copy_page ` | When a user copies the current page as markdown. |
636+ | ` docs.context_menu.copy_mcp_link ` | When a user copies the hosted MCP server link. |
637+ | ` docs.context_menu.ai_provider_click ` | When a user clicks an AI provider and create a conversation with current page as context. |
638+ | ` docs.context_menu.install_mcp_server ` | When a user installs the hosted MCP server on code editors. |
0 commit comments