Skip to content

Commit 3a50c90

Browse files
authored
update event names (#825)
1 parent c02273c commit 3a50c90

File tree

1 file changed

+21
-24
lines changed

1 file changed

+21
-24
lines changed

integrations/analytics/overview.mdx

Lines changed: 21 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -576,28 +576,25 @@ The syntax for `docs.json` is below. You only need to include entries for the pl
576576
```
577577
## Analytics events
578578

579-
We send the following events to your analytics provider.
579+
We send the following events to your analytics provider. All events use the `docs.` prefix.
580580

581-
| Event name | Description |
582-
|:-----------------------------------|:-------------------------------------------------------------------|
583-
| `accordion_close` | When a user closes an accordion. |
584-
| `accordion_open` | When a user opens an accordion. |
585-
| `api_playground_call` | When a user calls an API in the API playground. |
586-
| `code_block_copy` | When a user copies code from a code block. |
587-
| `cta_click` | When a user clicks a call to action. |
588-
| `expandable_close` | When a user closes an expandable. |
589-
| `expandable_open` | When a user opens an expandable. |
590-
| `header_nav_item_click` | When a user clicks a header navigation item. |
591-
| `pageview` | When a user views a page. |
592-
| `powered_by_mintlify_click` | When a user clicks the "Powered by Mintlify" link. |
593-
| `scroll_to_bottom` | When a user scrolls to the bottom of a page. |
594-
| `thumb_vote` | When a user votes (thumbs up or down) on a page. |
595-
| `ai_chat_citation_click` | When a user clicks a citation in a chat. |
596-
| `ai_chat_feedback_positive_click` | When a user clicks the positive feedback button in a chat. |
597-
| `ai_chat_feedback_negative_click` | When a user clicks the negative feedback button in a chat. |
598-
| `chat_completed` | When a chat session is completed. |
599-
| `chat_enter` | When a user initiates a chat. |
600-
| `chat_followup` | When a user sends a follow up message. |
601-
| `chat_shared` | When a user shares a chat conversation. |
602-
| `search_close` | When a user closes the search bar. |
603-
| `search_result_click` | When a user clicks a search result. |
581+
| Event name | Description |
582+
|:---------------------------------------|:--------------------------------------------------------------------|
583+
| `docs.accordion.close` | When a user closes an accordion. |
584+
| `docs.accordion.open` | When a user opens an accordion. |
585+
| `docs.api_playground.request` | When a user calls an API in the API playground. |
586+
| `docs.code_block.copy` | When a user copies code from a code block. |
587+
| `docs.code_block.ask_ai` | When a user asks the assistant to explain a code block. |
588+
| `docs.navitem.cta_click` | When a user clicks a call to action. |
589+
| `docs.expandable.close` | When a user closes an expandable. |
590+
| `docs.expandable.open` | When a user opens an expandable. |
591+
| `docs.navitem.click` | When a user clicks a header navigation item. |
592+
| `docs.footer.powered_by_mintlify_click` | When a user clicks the "Powered by Mintlify" link. |
593+
| `docs.assistant.source_click` | When a user clicks a citation in a chat. |
594+
| `docs.assistant.thumbs_up` | When a user clicks the positive feedback button in a chat. |
595+
| `docs.assistant.thumbs_down` | When a user clicks the negative feedback button in a chat. |
596+
| `docs.assistant.completed` | When a chat session is completed. |
597+
| `docs.assistant.enter` | When a user initiates a chat. |
598+
| `docs.assistant.shared` | When a user shares a chat conversation. |
599+
| `docs.search.close` | When a user closes the search bar. |
600+
| `docs.search.result_click` | When a user clicks a search result. |

0 commit comments

Comments
 (0)