Skip to content

Commit c14006d

Browse files
committed
bring events out of accordion
1 parent f3f91bd commit c14006d

File tree

1 file changed

+28
-26
lines changed

1 file changed

+28
-26
lines changed

integrations/analytics/overview.mdx

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: "Integrate with an analytics platform to track events"
55

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

8-
## All Integrations
8+
## All integrations
99

1010
<CardGroup cols={2}>
1111
<Card
@@ -516,7 +516,7 @@ fill="#7166F6"
516516
/>
517517
</CardGroup>
518518

519-
## Enabling Analytics
519+
## Enabling analytics
520520

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

@@ -574,31 +574,33 @@ The syntax for `docs.json` is below. You only need to include entries for the pl
574574
}
575575
}
576576
```
577+
## Analytics events
577578

578-
## FAQ
579+
We send the following events to your analytics provider.
579580

580-
<Accordion title="What events are tracked?">
581+
### User interaction events
582+
- `accordion_close`: When a user closes an accordion.
583+
- `accordion_open`: When a user opens an accordion.
584+
- `api_playground_call`: When a user calls an API in the API playground.
585+
- `code_block_copy`: When a user copies code from a code block.
586+
- `cta_click`: When a user clicks a call to action.
587+
- `expandable_close`: When a user closes an expandable.
588+
- `expandable_open`: When a user opens an expandable.
589+
- `header_nav_item_click`: When a user clicks a header navigation item.
590+
- `pageview`: When a user views a page.
591+
- `powered_by_mintlify_click`: When a user clicks the "Powered by Mintlify" link.
592+
- `scroll_to_bottom`: When a user scrolls to the bottom of a page.
593+
- `thumb_vote`: When a user votes (thumbs up or down) on a page.
581594

582-
- `expandable_open`
583-
- `expandable_close`
584-
- `accordion_open`
585-
- `accordion_close`
586-
- `header_nav_item_click`
587-
- `cta_click`
588-
- `scroll_to_bottom`
589-
- `search_close`
590-
- `api_playground_call`
591-
- `search_result_click`
592-
- `chat_enter`
593-
- `chat_followup`
594-
- `chat_completed`
595-
- `code_block_copy`
596-
- `chat_shared`
597-
- `thumb_vote`
598-
- `powered_by_mintlify_click`
599-
- `ai_chat_citation_click`
600-
- `ai_chat_feedback_positive_click`
601-
- `ai_chat_feedback_negative_click`
602-
- `pageview`
595+
### Chat events
596+
- `ai_chat_citation_click`: When a user clicks a citation in a chat.
597+
- `ai_chat_feedback_positive_click`: When a user clicks the positive feedback button in a chat.
598+
- `ai_chat_feedback_negative_click`: When a user clicks the negative feedback button in a chat.
599+
- `chat_completed`: When a chat session is completed.
600+
- `chat_enter`: When a user initiates a chat.
601+
- `chat_followup`: When a user sends a follow up message.
602+
- `chat_shared`: When a user shares a chat conversation.
603603

604-
</Accordion>
604+
### Search events
605+
- `search_close`: When a user closes the search bar.
606+
- `search_result_click`: When a user clicks a search result.

0 commit comments

Comments
 (0)