Skip to content

Update analytics event names for assistant feedback and add new autopilot events #2434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ethanpalm merged 6 commits into from
Dec 19, 2025
+7 −2
Merged

Update analytics event names for assistant feedback and add new autopilot events #2434

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
078b9b0
Update integrations/analytics/overview.mdx
cdxker Dec 18, 2025
e87a68f
Update integrations/analytics/overview.mdx
cdxker Dec 18, 2025
0f0f7c3
Apply suggestions from code review
ethanpalm Dec 19, 2025
6dbba98
Merge branch 'main' into mintlify/update-analytics-event-names-97361
ethanpalm Dec 19, 2025
a3407b1
Merge branch 'main' into mintlify/update-analytics-event-names-97361
ethanpalm Dec 19, 2025
84617ef
update headers
ethanpalm Dec 19, 2025
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
7 changes: 5 additions & 2 deletions integrations/analytics/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,7 @@

## Analytics events

We send the following events to your analytics provider. All events use the `docs.` prefix.

Check warning on line 611 in integrations/analytics/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/analytics/overview.mdx#L611 

Try to avoid using first-person plural like 'We'.

| Event name | Description |
| :-------------------------------------- | :-------------------------------------------------------------------------------------------------------- |
Expand All @@ -617,9 +617,10 @@
| `docs.api_playground.request` | When a user calls an API in the API playground. |
| `docs.code_block.copy` | When a user copies code from a code block. |
| `docs.code_block.ask_ai` | When a user asks the assistant to explain a code block. |
| `docs.content.view` | When a user views a page. Only available for analytics providers that do not track page views by default. |

Check warning on line 620 in integrations/analytics/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/analytics/overview.mdx#L620 

Use 'don't' instead of 'do not'.
| `docs.feedback.thumbs_up` | When a user clicks the positive feedback button. |
| `docs.feedback.thumbs_down` | When a user clicks the negative feedback button. |
| `docs.assistant.thumbs_up` | When a user clicks the positive feedback button on an assistant response. |
| `docs.assistant.thumbs_down` | When a user clicks the negative feedback button on an assistant response. |
| `docs.assistant.spam_detected` | When the assistant detects spam in a user message. |
| `docs.navitem.cta_click` | When a user clicks a call to action. |
| `docs.expandable.close` | When a user closes an expandable. |
| `docs.expandable.open` | When a user opens an expandable. |
Expand All @@ -627,10 +628,12 @@
| `docs.footer.powered_by_mintlify_click` | When a user clicks the "Powered by Mintlify" link. |
| `docs.assistant.source_click` | When a user clicks a citation in a chat. |
| `docs.assistant.suggestion_click` | When a user clicks a suggestion in a chat. |
| `docs.assistant.completed` | When a chat session is completed. |

Check warning on line 631 in integrations/analytics/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/analytics/overview.mdx#L631 

In general, use active voice instead of passive voice ('is completed').
| `docs.assistant.enter` | When a user initiates a chat. |
| `docs.assistant.ask_ai_on_text_selection` | When a user selects text and clicks "Ask AI" to ask about the selection. |
| `docs.assistant.shared` | When a user shares a chat conversation. |
| `docs.autopilot.suggestion.created` | When Autopilot creates a documentation suggestion. |
| `docs.autopilot.suggestion.no_suggestion` | When Autopilot determines no documentation update is needed. |

Check warning on line 636 in integrations/analytics/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/analytics/overview.mdx#L636 

In general, use active voice instead of passive voice ('is needed').
| `docs.search.close` | When a user closes the search bar. |
| `docs.search.result_click` | When a user clicks a search result. |
| `docs.context_menu.copy_page` | When a user copies the current page as markdown. |
Expand Down