Analytics integrations

Integrate with an analytics platform to track events

Automatically send data about your documentation engagement to your third party analytics provider.

All integrations

Amplitude

Mixpanel

PostHog

Google Analytics 4

Google Tag Manager

HotJar

Koala

LogRocket

Pirsch

Plausible

Fathom

Clearbit

Heap

Segment

Enabling analytics

Set your analytics keys in docs.json. You can add an unlimited number of analytics integrations for free.

The syntax for docs.json is below. You only need to include entries for the platforms you want to connect.

Analytics options in docs.json

"integrations": {
    "amplitude": {
        "apiKey": "required"
    },
    "clearbit": {
        "publicApiKey": "required"
    },
    "cookies": {
      "key": "required",
      "value": "required"
    },
    "fathom": {
        "siteId": "required"
    },
    "ga4": {
        "measurementId": "required"
    },
    "gtm": {
        "tagId": "required"
    },
    "hotjar": {
        "hjid": "required",
        "hjsv": "required"
    },
    "koala": {
        "publicApiKey": "required"
    },
    "logrocket": {
        "appId": "required"
    },
    "mixpanel": {
        "projectToken": "required"
    },
    "pirsch": {
        "id": "required"
    },
    "plausible": {
        "domain": "required"
    },
    "posthog": {
        "apiKey": "required",
        "apiHost": "optional"
    },
    "segment": {
      "key": "required"
    },
    "telemetry": {
      "enabled": "boolean"
    }
}

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.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.