Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 27 additions & 28 deletions integrations/analytics/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

<CardGroup cols={2}>
<Card
Expand Down Expand Up @@ -516,7 +516,7 @@ fill="#7166F6"
/>
</CardGroup>

## Enabling Analytics
## Enabling analytics

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

Expand Down Expand Up @@ -574,31 +574,30 @@ 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.

<Accordion title="What events are tracked?">

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

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