Skip to content
Open
Show file tree
Hide file tree
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
19 changes: 11 additions & 8 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -1653,7 +1648,7 @@
},
{
"source": "/guides/analytics",
"destination": "/insights/overview"
"destination": "/optimize/analytics"
},
{
"source": "/guides/assistant",
Expand Down Expand Up @@ -1858,6 +1853,14 @@
{
"source": "/ai/suggestions",
"destination": "/agent/suggestions"
},
{
"source": "/insights/overview",
"destination": "/optimize/analytics"
},
{
"source": "/insights/feedback",
"destination": "/optimize/feedback"
}
],
"integrations": {
Expand Down
Binary file added images/analytics/feedback-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/analytics/feedback-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 0 additions & 26 deletions insights/overview.mdx

This file was deleted.

45 changes: 45 additions & 0 deletions optimize/analytics.mdx
Original file line number Diff line number Diff line change
@@ -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.

Check warning on line 39 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L39

Spell out 'CTR', if it's unfamiliar to the audience.

Check warning on line 39 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L39

Spell out 'CTR', if it's unfamiliar to the audience.

Check warning on line 39 in optimize/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/analytics.mdx#L39

Spell out 'CTR', if it's unfamiliar to the audience.

## 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.
66 changes: 36 additions & 30 deletions insights/feedback.mdx → optimize/feedback.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,75 +5,81 @@
---

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

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.

<Frame>
<img
className="block dark:hidden"
src="/images/analytics/feedback-light.png"
alt="Feedback tab in the Analytics page."
/>
<img
className="hidden dark:block"
src="/images/analytics/feedback-dark.png"
alt="Feedback tab in the Analytics page."
/>
</Frame>

## Feedback types

<Note>
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).
</Note>

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.

<Frame>

<img
className="block dark:hidden pointer-events-none"
src="/images/analytics/feedback-addons-light.png"
alt="Screenshot of the feedback toggles in the Add-ons page."
/>

<img
className="hidden dark:block pointer-events-none"
src="/images/analytics/feedback-addons-dark.png"
alt="Screenshot of the feedback toggles in the Add-ons page."
/>

<img
className="block dark:hidden"
src="/images/analytics/feedback-addons-light.png"
alt="Feedback toggles in the Add-ons page."
/>
<img
className="hidden dark:block"
src="/images/analytics/feedback-addons-dark.png"
alt="Feedback toggles in the Add-ons page."
/>
</Frame>

* **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.

<Note>
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.

Check warning on line 54 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L54

Use 'turn off' or 'off' instead of 'disable'.

Check warning on line 54 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L54

Avoid using 'will'.
</Note>

## 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**.

Best practices for setting feedback statuses:

* **Pending**: Feedback is awaiting review.
* **In Progress**: Feedback has been validated and is being worked on.

Check warning on line 68 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L68

In general, use active voice instead of passive voice ('been validated').

Check warning on line 68 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L68

In general, use active voice instead of passive voice ('being worked').
* **Resolved**: Feedback has been resolved.

Check warning on line 69 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L69

In general, use active voice instead of passive voice ('been resolved').
* **Dismissed**: Feedback has been dismissed as not actionable, irrelevant, or inaccurate.

Check warning on line 70 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L70

In general, use active voice instead of passive voice ('been dismissed').

### 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.

Check warning on line 74 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L74

In general, use active voice instead of passive voice ('is displayed').

Check warning on line 74 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L74

In general, use active voice instead of passive voice ('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:

Expand Down