From c14006d13d8e633b21d95a35de75f8a96164c912 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 12 Jun 2025 15:56:23 -0700 Subject: [PATCH 1/2] bring events out of accordion --- integrations/analytics/overview.mdx | 54 +++++++++++++++-------------- 1 file changed, 28 insertions(+), 26 deletions(-) diff --git a/integrations/analytics/overview.mdx b/integrations/analytics/overview.mdx index c9831cf86..c83328cd3 100644 --- a/integrations/analytics/overview.mdx +++ b/integrations/analytics/overview.mdx @@ -5,7 +5,7 @@ description: "Integrate with an analytics platform to track events" Automatically send data about your documentation engagement to your third party analytics provider. -## All Integrations +## All integrations -## Enabling Analytics +## Enabling analytics Set your analytics keys in `docs.json`. You can add an unlimited number of analytics integrations for free. @@ -574,31 +574,33 @@ The syntax for `docs.json` is below. You only need to include entries for the pl } } ``` +## Analytics events -## FAQ +We send the following events to your analytics provider. - +### User interaction events +- `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. -- `expandable_open` -- `expandable_close` -- `accordion_open` -- `accordion_close` -- `header_nav_item_click` -- `cta_click` -- `scroll_to_bottom` -- `search_close` -- `api_playground_call` -- `search_result_click` -- `chat_enter` -- `chat_followup` -- `chat_completed` -- `code_block_copy` -- `chat_shared` -- `thumb_vote` -- `powered_by_mintlify_click` -- `ai_chat_citation_click` -- `ai_chat_feedback_positive_click` -- `ai_chat_feedback_negative_click` -- `pageview` +### Chat events +- `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 events +- `search_close`: When a user closes the search bar. +- `search_result_click`: When a user clicks a search result. From 9a2e84a9b92be80729495ed1db7649b23dd7303d Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Thu, 12 Jun 2025 16:42:39 -0700 Subject: [PATCH 2/2] change list to table --- integrations/analytics/overview.mdx | 49 ++++++++++++++--------------- 1 file changed, 23 insertions(+), 26 deletions(-) diff --git a/integrations/analytics/overview.mdx b/integrations/analytics/overview.mdx index c83328cd3..4f689c0e7 100644 --- a/integrations/analytics/overview.mdx +++ b/integrations/analytics/overview.mdx @@ -578,29 +578,26 @@ The syntax for `docs.json` is below. You only need to include entries for the pl We send the following events to your analytics provider. -### User interaction events -- `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. - -### Chat events -- `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 events -- `search_close`: When a user closes the search bar. -- `search_result_click`: When a user clicks a search result. +| 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. |