Automatically send data about your documentation engagement to your third party analytics provider.
All Integrations
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"
}
}
FAQ
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