From 24bda0cd7e977b4f5839ad798d3bb5391c921ef1 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 18 Dec 2025 01:52:59 +0000 Subject: [PATCH 1/6] Update integrations/analytics/overview.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- integrations/analytics/overview.mdx | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/integrations/analytics/overview.mdx b/integrations/analytics/overview.mdx index 94e5c7115..38a8108a4 100644 --- a/integrations/analytics/overview.mdx +++ b/integrations/analytics/overview.mdx @@ -4,7 +4,15 @@ description: "Connect to analytics platforms to track user engagement and docume keywords: ["third-party analytics", "engagement tracking", "analytics platforms", "usage tracking"] --- -Automatically send data about your documentation engagement to your third party analytics provider. +Track how users interact with your documentation by connecting to third-party analytics platforms. Mintlify automatically sends engagement events to your analytics provider. + +## How it works + +When you add analytics integrations to your documentation: + +1. **Automatic event tracking** - Mintlify tracks user interactions like page views, search queries, API playground requests, and feedback submissions +2. **Multiple providers** - Connect to unlimited analytics platforms simultaneously at no extra cost +3. **Zero configuration** - Just add your API keys to `docs.json` and events start flowing automatically ## All integrations From c5337a9801af50700a078bb33a7afd3854f922b7 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 18 Dec 2025 01:53:06 +0000 Subject: [PATCH 2/6] Update integrations/analytics/overview.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- integrations/analytics/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/integrations/analytics/overview.mdx b/integrations/analytics/overview.mdx index 38a8108a4..460738956 100644 --- a/integrations/analytics/overview.mdx +++ b/integrations/analytics/overview.mdx @@ -14,7 +14,7 @@ When you add analytics integrations to your documentation: 2. **Multiple providers** - Connect to unlimited analytics platforms simultaneously at no extra cost 3. **Zero configuration** - Just add your API keys to `docs.json` and events start flowing automatically -## All integrations +## Supported platforms Date: Thu, 18 Dec 2025 01:53:14 +0000 Subject: [PATCH 3/6] Update integrations/analytics/overview.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- integrations/analytics/overview.mdx | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/integrations/analytics/overview.mdx b/integrations/analytics/overview.mdx index 460738956..7a51b4647 100644 --- a/integrations/analytics/overview.mdx +++ b/integrations/analytics/overview.mdx @@ -551,13 +551,11 @@ fill="#7166F6" /> -## Enabling analytics +## Setup -Set your analytics keys in `docs.json`. You can add an unlimited number of analytics integrations for free. +Add your analytics provider credentials to the `integrations` object in `docs.json`. Only include the platforms you want to use. -The syntax for `docs.json` is below. You only need to include entries for the platforms you want to connect. - -```json Analytics options in docs.json +```json docs.json "integrations": { "amplitude": { "apiKey": "required" From 464b5914a450ea01fe19edbdd91a0def8fc6d0f9 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 18 Dec 2025 01:53:22 +0000 Subject: [PATCH 4/6] Update integrations/analytics/overview.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- integrations/analytics/overview.mdx | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/integrations/analytics/overview.mdx b/integrations/analytics/overview.mdx index 7a51b4647..54c254ce1 100644 --- a/integrations/analytics/overview.mdx +++ b/integrations/analytics/overview.mdx @@ -612,9 +612,30 @@ Add your analytics provider credentials to the `integrations` object in `docs.js } ``` -## Analytics events +### Example configuration -We send the following events to your analytics provider. All events use the `docs.` prefix. +Here's an example with multiple analytics providers: + +```json docs.json +{ + "integrations": { + "ga4": { + "measurementId": "G-XXXXXXXXXX" + }, + "posthog": { + "apiKey": "phc_xxxxxxxxxxxxx", + "apiHost": "https://app.posthog.com" + }, + "mixpanel": { + "projectToken": "xxxxxxxxxxxxx" + } + } +} +``` + +## Tracked events + +Mintlify automatically tracks the following user interactions and sends them to your analytics provider. All events use the `docs.` prefix. | Event name | Description | | :-------------------------------------- | :-------------------------------------------------------------------------------------------------------- | From fcdc4610f49a94d1b48bd4b317a55f1fb3c7e779 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 18 Dec 2025 01:53:42 +0000 Subject: [PATCH 5/6] Update integrations/analytics/overview.mdx Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> --- integrations/analytics/overview.mdx | 82 ++++++++++++++++++++--------- 1 file changed, 57 insertions(+), 25 deletions(-) diff --git a/integrations/analytics/overview.mdx b/integrations/analytics/overview.mdx index 54c254ce1..0fe59a6e7 100644 --- a/integrations/analytics/overview.mdx +++ b/integrations/analytics/overview.mdx @@ -637,30 +637,62 @@ Here's an example with multiple analytics providers: Mintlify automatically tracks the following user interactions and sends them to your analytics provider. All events use the `docs.` prefix. +### Navigation and page views + +| Event name | Description | +| :-------------------------------------- | :-------------------------------------------------------------------------------------------------------- | +| `docs.content.view` | User views a page. Only sent to providers that don't track page views by default. | +| `docs.navitem.click` | User clicks a header navigation item. | +| `docs.navitem.cta_click` | User clicks a call to action button. | +| `docs.footer.powered_by_mintlify_click` | User clicks the "Powered by Mintlify" link. | + +### Search + +| Event name | Description | +| :-------------------------------------- | :-------------------------------------------------------------------------------------------------------- | +| `docs.search.close` | User closes the search bar. | +| `docs.search.result_click` | User clicks a search result. | + +### Code and API playground + +| Event name | Description | +| :-------------------------------------- | :-------------------------------------------------------------------------------------------------------- | +| `docs.code_block.copy` | User copies code from a code block. | +| `docs.code_block.ask_ai` | User asks the assistant to explain a code block. | +| `docs.api_playground.request` | User makes an API request in the API playground. | + +### Interactive components + +| Event name | Description | +| :-------------------------------------- | :-------------------------------------------------------------------------------------------------------- | +| `docs.accordion.open` | User opens an accordion. | +| `docs.accordion.close` | User closes an accordion. | +| `docs.expandable.open` | User opens an expandable. | +| `docs.expandable.close` | User closes an expandable. | + +### Feedback + +| Event name | Description | +| :-------------------------------------- | :-------------------------------------------------------------------------------------------------------- | +| `docs.feedback.thumbs_up` | User clicks the positive feedback button. | +| `docs.feedback.thumbs_down` | User clicks the negative feedback button. | + +### AI assistant + +| Event name | Description | +| :-------------------------------------- | :-------------------------------------------------------------------------------------------------------- | +| `docs.assistant.enter` | User opens the AI assistant. | +| `docs.assistant.completed` | Chat session completes. | +| `docs.assistant.source_click` | User clicks a citation in a chat response. | +| `docs.assistant.suggestion_click` | User clicks a suggested question. | +| `docs.assistant.ask_ai_on_text_selection` | User selects text and clicks "Ask AI". | +| `docs.assistant.shared` | User shares a chat conversation. | + +### Context menu + | 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.completed` | When a chat session is completed. | -| `docs.assistant.enter` | When a user initiates a chat. | -| `docs.assistant.ask_ai_on_text_selection` | When a user selects text and clicks "Ask AI" to ask about the selection. | -| `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. | +| `docs.context_menu.copy_page` | User copies the current page as markdown. | +| `docs.context_menu.copy_mcp_link` | User copies the hosted MCP server link. | +| `docs.context_menu.ai_provider_click` | User clicks an AI provider to create a conversation with the current page as context. | +| `docs.context_menu.install_mcp_server` | User installs the hosted MCP server on code editors. | From 5236e49e9f0c0e4e2fa37a80f98f3cc43ed33c06 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 19 Dec 2025 09:59:58 -0800 Subject: [PATCH 6/6] copy edit --- integrations/analytics/overview.mdx | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/integrations/analytics/overview.mdx b/integrations/analytics/overview.mdx index 0fe59a6e7..37b22ef57 100644 --- a/integrations/analytics/overview.mdx +++ b/integrations/analytics/overview.mdx @@ -4,15 +4,11 @@ description: "Connect to analytics platforms to track user engagement and docume keywords: ["third-party analytics", "engagement tracking", "analytics platforms", "usage tracking"] --- -Track how users interact with your documentation by connecting to third-party analytics platforms. Mintlify automatically sends engagement events to your analytics provider. +Track how users interact with your documentation by connecting to third-party analytics platforms. Mintlify sends engagement events to your configured analytics providers. -## How it works +## How analytic integrations work -When you add analytics integrations to your documentation: - -1. **Automatic event tracking** - Mintlify tracks user interactions like page views, search queries, API playground requests, and feedback submissions -2. **Multiple providers** - Connect to unlimited analytics platforms simultaneously at no extra cost -3. **Zero configuration** - Just add your API keys to `docs.json` and events start flowing automatically +When you add analytics integrations to your documentation site, Mintlify tracks user interactions like page views, search queries, API playground requests, and feedback submissions and sends them to your analytics providers. You can connect any number of supported analytics providers by adding your API keys to the `docs.json` file. Analytics events flow to your providers as soon as you add them to your configuration with no further configuration required. ## Supported platforms @@ -614,8 +610,6 @@ Add your analytics provider credentials to the `integrations` object in `docs.js ### Example configuration -Here's an example with multiple analytics providers: - ```json docs.json { "integrations": { @@ -635,7 +629,7 @@ Here's an example with multiple analytics providers: ## Tracked events -Mintlify automatically tracks the following user interactions and sends them to your analytics provider. All events use the `docs.` prefix. +All tracked events use the `docs.` prefix. ### Navigation and page views @@ -685,7 +679,7 @@ Mintlify automatically tracks the following user interactions and sends them to | `docs.assistant.completed` | Chat session completes. | | `docs.assistant.source_click` | User clicks a citation in a chat response. | | `docs.assistant.suggestion_click` | User clicks a suggested question. | -| `docs.assistant.ask_ai_on_text_selection` | User selects text and clicks "Ask AI". | +| `docs.assistant.ask_ai_on_text_selection` | User selects text and clicks "Ask AI." | | `docs.assistant.shared` | User shares a chat conversation. | ### Context menu