diff --git a/docs.json b/docs.json index bc71e857a..30e9947eb 100644 --- a/docs.json +++ b/docs.json @@ -182,13 +182,8 @@ "ai/discord", "ai/slack-bot", "ai/contextual-menu", - { - "group": "Insights", - "pages": [ - "insights/overview", - "insights/feedback" - ] - }, + "optimize/analytics", + "optimize/feedback", "ai/llmstxt", "ai/skillmd", "ai/model-context-protocol", @@ -1653,7 +1648,7 @@ }, { "source": "/guides/analytics", - "destination": "/insights/overview" + "destination": "/optimize/analytics" }, { "source": "/guides/assistant", @@ -1858,6 +1853,14 @@ { "source": "/ai/suggestions", "destination": "/agent/suggestions" + }, + { + "source": "/insights/overview", + "destination": "/optimize/analytics" + }, + { + "source": "/insights/feedback", + "destination": "/optimize/feedback" } ], "integrations": { diff --git a/images/analytics/feedback-dark.png b/images/analytics/feedback-dark.png new file mode 100644 index 000000000..d0ef5ce9b Binary files /dev/null and b/images/analytics/feedback-dark.png differ diff --git a/images/analytics/feedback-light.png b/images/analytics/feedback-light.png new file mode 100644 index 000000000..edb31e634 Binary files /dev/null and b/images/analytics/feedback-light.png differ diff --git a/insights/overview.mdx b/insights/overview.mdx deleted file mode 100644 index 00f38590f..000000000 --- a/insights/overview.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Overview" -description: "Track documentation analytics and understand content effectiveness with visitor data." -keywords: ["analytics", "metrics", "page views", "traffic", "trends", "insights"] ---- - -The overview tab shows how many people have visited your docs, what pages are most popular, and where users are coming from. Use this information to identify which pages are most valuable to your users and track trends over time. - -Access the overview metrics by navigating to the **Analytics** page in your [dashboard](https://dashboard.mintlify.com/products/analytics). - -## Metrics - -Use the range selector to adjust the time period for displayed data. Select visitors, views, or actions to display a line graph showing trends over the selected time period. - -- **Visitors**: Unique visitors -- **Views**: Total page views -- **Actions**: Combined count of API calls, navbar link clicks, and CTA button clicks -- **Popular Pages**: Paths to the most-visited pages and their view counts -- **Referrers**: Top traffic sources directing users to your docs - -## Using overview data - -Review your overview analytics to: - -- **Identify popular pages**: Use popular pages to understand what content is most important to your users so that you can make sure it is up to date and comprehensive. -- **Track traffic trends**: Monitor changes in traffic to understand the impact of updates or new content. diff --git a/optimize/analytics.mdx b/optimize/analytics.mdx new file mode 100644 index 000000000..990e049c6 --- /dev/null +++ b/optimize/analytics.mdx @@ -0,0 +1,45 @@ +--- +title: "Analytics" +description: "Track documentation analytics and understand content effectiveness with visitor data." +keywords: ["analytics", "metrics", "page views", "traffic", "trends", "insights"] +--- + +The [Analytics page](https://dashboard.mintlify.com/products/analytics) shows data about visitors to your docs, how they interact with the assistant, what they search for, and their feedback. Use this information to identify which pages are most valuable to your users and track trends over time. + +Use the range selector to adjust the time period for displayed data. + +## Visitors + +The visitors tab displays a bar chart of visitors over time, a list of popular pages, and a list of referrers. + +Review your visitors analytics to: + +- **Monitor traffic trends**: Observe changes in traffic after updates or new content to understand the impact of your changes. +- **Identify popular pages**: Use popular pages to understand what content is most important to your users so that you can make sure it is up to date and comprehensive. +- **Track traffic sources**: Understand where your users are coming from to help you optimize your content for the right audience. + +## Assistant + +The assistant tab displays a bar chart of assistant usage over time, a list of categories, and chat history. + +Review your assistant analytics to: + +- **Monitor assistant usage**: Observe changes in assistant usage to understand how your users engage with your content. +- **Identify frequent categories**: Use high occurrence categories to understand what topics are most important to your users. Identify gaps in coverage and prioritize content updates. +- **Review chat history**: Get detailed high intent data about how your users think about your product by reviewing their chat history with the assistant. See what terms they use, what they need help with, and what tasks they try to accomplish. + +## Searches + +The searches tab displays a bar chart of searches over time and specific queries. + +Review your searches analytics to: + +- **Monitor search trends**: Observe changes in search queries to understand how your users are finding your content and what topics they want information on. +- **Identify frequent queries**: Use frequent queries to understand what topics are most important to your users. Identify gaps in coverage and prioritize content updates. +- **Identify low click through rates**: Click through rates (CTR) show how many users click a search result after typing in a query. Low CTR can indicate that the search results are not relevant to users' queries. If you have frequent search terms with low CTR, consider improving the relevance of search results by adding keywords and updating your content. + +## Feedback + +The feedback tab displays a bar chart of feedback over time and specific feedback items. + +See [Feedback](/optimize/feedback) for more information on using feedback data to improve your content. diff --git a/insights/feedback.mdx b/optimize/feedback.mdx similarity index 56% rename from insights/feedback.mdx rename to optimize/feedback.mdx index a6f52a1bc..a571b3eae 100644 --- a/insights/feedback.mdx +++ b/optimize/feedback.mdx @@ -5,54 +5,60 @@ keywords: ["user feedback", "thumbs rating", "contextual feedback", "satisfactio --- - To collect and view feedback, you must first enable feedback from the [Add-ons](https://dashboard.mintlify.com/products/addons) page in your dashboard. + To collect and view feedback, you must enable feedback from the [Add-ons](https://dashboard.mintlify.com/products/addons) page in your dashboard. The feedback tab displays quantitative thumbs up and thumbs down votes your docs have received and any qualitative feedback that users have provided. Use this information to gauge the quality of your docs and make improvements. -Access the feedback tab by navigating to the **Analytics** page in your [dashboard](https://dashboard.mintlify.com/products/analytics). +View feedback on the [Analytics](https://dashboard.mintlify.com/products/analytics) page in your dashboard. + + + Feedback tab in the Analytics page. + Feedback tab in the Analytics page. + ## Feedback types - Contextual and code snippet feedback are in beta. To enable them for your documentation site, [contact our sales team](mailto:hahnbee@mintlify.com). + Contextual and code snippet feedback are in beta. To enable them for your documentation site, [contact our sales team](mailto:hahnbee@mintlify.com). -The feedback tab displays information according to the feedback add-ons that you enable. - -Enable your preferred feedback types: +The feedback tab displays information according to the [feedback add-ons](https://dashboard.mintlify.com/products/addons) that you enable. - -Screenshot of the feedback toggles in the Add-ons page. - -Screenshot of the feedback toggles in the Add-ons page. - + Feedback toggles in the Add-ons page. + Feedback toggles in the Add-ons page. -* **Thumbs rating only**: Simple thumbs up/down voting to gauge overall satisfaction with pages. -* **Code snippet feedback only**: Feedback specifically on code snippets. -* **Thumbs rating and contextual feedback**: Page voting plus detailed comments and reasons for ratings. -* **Thumbs rating and code snippet feedback**: Page voting plus feedback on code examples. -* **Thumbs rating, contextual, and code snippet feedback**: Complete feedback system with page voting, detailed comments, and code snippet feedback. +* **Thumbs rating**: Simple thumbs up/down voting to gauge overall satisfaction with pages. +* **Contextual feedback**: Free form feedback about the content of a page. +* **Code snippet feedback**: Feedback specifically on code snippets. If you disable telemetry in your `docs.json` file, feedback features will not appear on your documentation pages, even if you enable them in your dashboard. -## Managing feedback +## Manage feedback For contextual and code snippet feedback, you can set the status of a piece of feedback and add internal notes to track your work resolving user feedback. -### Changing feedback status +### Change feedback status Select the status beside a piece of feedback to mark it as **Pending**, **In Progress**, **Resolved**, or **Dismissed**. @@ -63,17 +69,17 @@ Best practices for setting feedback statuses: * **Resolved**: Feedback has been resolved. * **Dismissed**: Feedback has been dismissed as not actionable, irrelevant, or inaccurate. -### Filtering by status +### Filter by status Use the status filter to control which feedback is displayed. Clear a status to hide all feedback with that status. By default, all feedback is displayed. -### Adding internal notes +### Add internal notes -Click on a piece of feedback to add an internal note. These notes are only visible to people with access to your dashboard. +Click a piece of feedback to add an internal note. These notes are only visible to people with access to your dashboard. Use notes to add information for collaboration, link relevant support or engineering tickets, or remember any other useful information. -## Using feedback data +## Use feedback data Review your feedback data to: