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.

Event nameDescription
accordion_closeWhen a user closes an accordion.
accordion_openWhen a user opens an accordion.
api_playground_callWhen a user calls an API in the API playground.
code_block_copyWhen a user copies code from a code block.
cta_clickWhen a user clicks a call to action.
expandable_closeWhen a user closes an expandable.
expandable_openWhen a user opens an expandable.
header_nav_item_clickWhen a user clicks a header navigation item.
pageviewWhen a user views a page.
powered_by_mintlify_clickWhen a user clicks the “Powered by Mintlify” link.
scroll_to_bottomWhen a user scrolls to the bottom of a page.
thumb_voteWhen a user votes (thumbs up or down) on a page.
ai_chat_citation_clickWhen a user clicks a citation in a chat.
ai_chat_feedback_positive_clickWhen a user clicks the positive feedback button in a chat.
ai_chat_feedback_negative_clickWhen a user clicks the negative feedback button in a chat.
chat_completedWhen a chat session is completed.
chat_enterWhen a user initiates a chat.
chat_followupWhen a user sends a follow up message.
chat_sharedWhen a user shares a chat conversation.
search_closeWhen a user closes the search bar.
search_result_clickWhen a user clicks a search result.