Skip to content
Closed
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
2 changes: 2 additions & 0 deletions analytics/assistant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ The **Assistant** view of the [analytics](https://app.mintlify.com/analytics) pa

Mintlify replaces email addresses and phone numbers in assistant conversations with `[REDACTED_EMAIL]` and `[REDACTED_PHONE]` before showing them in the dashboard. The same redaction applies to [CSV exports](/analytics/export) and the [analytics API](/api/analytics/assistant-conversations).

Mintlify keeps assistant conversations for 365 days, then deletes them.

Review assistant analytics to:

- **Monitor assistant usage**: Observe changes in assistant usage to understand how users engage with your content.
Expand Down
2 changes: 2 additions & 0 deletions analytics/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ Analytics data typically appears within a few minutes of an interaction. Very re

Use the range selector in an analytics view to adjust the time period for the displayed data. Select a preset, like **Last 7 days** or **All time**, or a custom range on the calendar. Exports also use the selected time range.

Mintlify keeps analytics data for 365 days, so **All time** shows up to the last 365 days of data. To keep a longer record, [export](/analytics/export) your analytics or [stream analytics events](/analytics/streaming) to your own storage.

## Filter by page or path

Use the **Filter** menu to scope the dashboard to a single page or path. When you select a path, the analytics page displays data for every page under that path. For example, if you filter to `docs/authentication`, the analytics page displays data for every page in the `docs/authentication/*` path. The Assistant and Search views always show site-wide data.
Expand Down
2 changes: 1 addition & 1 deletion dashboard/audit-logs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Use audit logs to monitor and track actions performed by members of your organiz

Only organization admins can view and export audit logs.

Navigate to the [Audit log](https://app.mintlify.com/settings/organization/audit-logs) page of your dashboard to view audit logs. Mintlify retains audit log entries for up to one year. You can view and export entries from the last 90 days. Export logs to CSV regularly to keep a longer record.
Navigate to the [Audit log](https://app.mintlify.com/settings/organization/audit-logs) page of your dashboard to view audit logs. Mintlify retains audit log entries for 455 days. You can view and export entries from the last 90 days. Export logs to CSV regularly to keep a longer record.

Click any log entry to open its details, including:

Expand Down
2 changes: 1 addition & 1 deletion mint-instructions/access/team.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

If you meant who can read the published docs site (login, password, groups), run `mint instructions access` instead.

Use this to add teammates, set roles, SSO, SCIM, session or IP policies, audit logs, contacts, notifications, or the desktop app. All of it is configured in the dashboard (https://app.mintlify.com). You cannot set any of it from the repo, `docs.json`, or the `mint` CLI. Give the user exact steps and links.

Check warning on line 11 in mint-instructions/access/team.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/access/team.mdx#L11

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

## Workflow

Expand All @@ -19,18 +19,18 @@
- Editor: everything a viewer can, plus edit in the web editor, publish, create/rename/delete pages, reorder navigation, upload media, trigger, roll back and promote deployments, create/delete API keys, configure integrations, assistant and add-ons, make changes with the Slack agent, accept or reject suggestions, invite editors and viewers.
- Admin: everything, plus update roles, invite admins, delete users, billing, SSO, SCIM, IP allowlist and session lifetimes, audit logs, security contact, custom domain, Git source, custom subpath, delete a project, agent publishing setting, delete organization, delete any comment.
- Change a role: **Members** page, **Role** dropdown (saves immediately, applies on next dashboard load). You cannot change your own role. **Managed by SSO** rows change in the IdP.
4. Offboard: **Members** page, actions menu. **Remove member** deletes membership, access and their keys. **Revoke credentials** keeps membership and revokes any of: Sessions, CLI tokens, API keys, Discovery API keys, M2M clients, Connected apps. Not reversible; you cannot revoke your own.

Check warning on line 22 in mint-instructions/access/team.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/access/team.mdx#L22

Did you really mean 'Offboard'?
5. SSO (Enterprise, admin): **Security** page (https://app.mintlify.com/settings/organization/access), **SSO** section. Each button opens the Admin Portal, which has the identity provider steps.
- First **Verify email domains**: add your team's email domain and its DNS record in the Admin Portal. **Set up SSO** stays disabled until a domain shows **Verified**.
- Then **Set up SSO** and follow the Admin Portal steps. When connected, the section shows **SAML SSO** with a **Connected** badge. **Manage SSO** reopens the portal.
- After you connect SSO, Mintlify sends anyone signing in with a verified-domain email to the IdP. Test sign-in from the login page and from the IdP in a private window.
- First SSO sign-in adds the user to the organization with the role the IdP assigns, or editor if none.
- Existing SSO or SCIM set up before the Admin Portal: reconnect by November 20, 2026 from the dashboard banner's **Set up now** (admins only). See https://www.mintlify.com/docs/help-center/reconnect-existing-sso-and-scim.

Check warning on line 28 in mint-instructions/access/team.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/access/team.mdx#L28

Use 'SSO' instead of 'sso'.

Check warning on line 28 in mint-instructions/access/team.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/access/team.mdx#L28

Use 'SCIM' instead of 'scim'.
6. SCIM (Enterprise, admin): **Security** page, **SCIM** section, **Set up directory sync**, follow the Admin Portal steps. **Manage directory** reopens the portal. Roles follow the IdP's role assignments; provisioned members show **Managed by SSO** on **Members**, so change their roles in the IdP.
7. Session and network policies (Enterprise, admin): **Security** page, **Policies** section.
- **Idle session timeout** and **Maximum session lifetime**: each 5 minutes to 14 days, own toggle, click **Save**. Session ends at whichever limit hits first. Off: idle timeout falls back to 14 days, max lifetime has no limit. Lowering max lifetime ends older sessions on their next request.
- **Allowed IP addresses**: IPv4/IPv6 or CIDR (`203.0.113.7`, `10.0.0.0/8`), press Enter, **Add and enable** on the first entry. Applies to dashboard and editor, including SSO sign-ins, not the published docs site. Empty list means open.
8. Audit logs (Enterprise, admins only): **Audit log** page (https://app.mintlify.com/settings/organization/audit-logs). Retained up to one year; view and export the last 90 days. Filter by date and category; SSO, SCIM and automation events appear under **All categories**. **Export CSV** emails a download link. Streaming: **Stream configuration**, **Configure**, **Add destination**, Amazon S3 (bucket, region, access key ID, secret, optional prefix; needs `s3:PutObject`) or Datadog (site and API key, not an application key).
8. Audit logs (Enterprise, admins only): **Audit log** page (https://app.mintlify.com/settings/organization/audit-logs). Retained 455 days; view and export the last 90 days. Filter by date and category; SSO, SCIM and automation events appear under **All categories**. **Export CSV** emails a download link. Streaming: **Stream configuration**, **Configure**, **Add destination**, Amazon S3 (bucket, region, access key ID, secret, optional prefix; needs `s3:PutObject`) or Datadog (site and API key, not an application key).
9. Contacts: **General** page (https://app.mintlify.com/settings/organization/general). Admins set **Security contact email** (Enterprise) and **Admin contact emails** (billing alerts, deployment notifications).
10. Personal settings (each member, own account only):
- Profile (https://app.mintlify.com/settings/account): name, picture, **Starting page**, theme, **Always open in desktop app**, connect GitHub (signs web editor commits as you).
Expand All @@ -41,7 +41,7 @@

- Never claim you configured members, roles, SSO, SCIM or policies. Hand the user the steps; an admin must do the admin-only ones.
- Dashboard roles do not gate Git. Anyone with write access to the repo can push, and pushes to the deploy branch deploy regardless of role. Lock down the repo separately.
- Before an IP allowlist, confirm the admin's current IP (shown in **Policies**) is on it, or they lock themselves out.

Check warning on line 44 in mint-instructions/access/team.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/access/team.mdx#L44

Did you really mean 'admin's'?

## Examples

Expand All @@ -59,6 +59,6 @@

- `mint instructions access` (docs-site reader access)
- https://www.mintlify.com/docs/dashboard/roles
- https://www.mintlify.com/docs/dashboard/sso

Check warning on line 62 in mint-instructions/access/team.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/access/team.mdx#L62

Use 'SSO' instead of 'sso'.
- https://www.mintlify.com/docs/dashboard/scim

Check warning on line 63 in mint-instructions/access/team.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/access/team.mdx#L63

Use 'SCIM' instead of 'scim'.
- https://www.mintlify.com/docs/dashboard/network-access
2 changes: 1 addition & 1 deletion mint-instructions/publish/analytics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@
---
Use this for docs performance questions, data-driven fixes, or adding analytics, chat, or consent tooling to the site. Analytics and feedback require a Pro or Enterprise plan.

## Workflow: read the data

Check warning on line 10 in mint-instructions/publish/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/publish/analytics.mdx#L10

'Workflow: read the data' should use sentence-style capitalization.

1. Run `mint status` to confirm you are logged in (`mint login` if not).

Check warning on line 12 in mint-instructions/publish/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/publish/analytics.mdx#L12

In general, use active voice instead of passive voice ('are logged').

Check warning on line 12 in mint-instructions/publish/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/publish/analytics.mdx#L12

Use 'signed in' instead of 'logged in'.
2. Pick the subdomain and range. Shared flags on every subcommand: `--subdomain`, `--from YYYY-MM-DD`, `--to YYYY-MM-DD` (defaults: last 7 days to today), `--format table|plain|json|graph`. Output defaults to `json` in AI or CI environments. Persist defaults with `mint config set subdomain <sub>` (also `dateFrom`, `dateTo`).
3. Run the subcommand that answers the question:
- `mint analytics stats [--page <path>]`: views, visitors, searches, feedback, assistant usage. Human and agent traffic are reported separately.

Check warning on line 15 in mint-instructions/publish/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/publish/analytics.mdx#L15

In general, use active voice instead of passive voice ('are reported').
- `mint analytics search [--query <substring>] [--page <path>]`: queries with hit counts, click-through rate, top clicked page, last searched date.
- `mint analytics feedback [--type page|code] [--page <path>]`: individual entries by default, `--type page` aggregates by page, `--type code` keeps only code snippet feedback.
- `mint analytics conversation list [--page <path>]`: recent assistant conversations (timestamp, first query, category). `--page` filters to conversations whose sources reference that page.
Expand All @@ -31,15 +31,15 @@

## Dashboard views (tell the user, you cannot click them)

At https://app.mintlify.com/analytics: Traffic (visitors, views, referrals, popular pages, human vs agent traffic, agent breakdown by provider), Assistant (categories, topics, satisfaction, transcripts), Search (volume, frequent queries, CTR), User engagements (CTA clicks, actions, user flow, search and assistant funnels), Feedback, and Savings (Enterprise only). Filter by time range or by page/path (Assistant and Search are always site-wide).
At https://app.mintlify.com/analytics: Traffic (visitors, views, referrals, popular pages, human vs agent traffic, agent breakdown by provider), Assistant (categories, topics, satisfaction, transcripts), Search (volume, frequent queries, CTR), User engagements (CTA clicks, actions, user flow, search and assistant funnels), Feedback, and Savings (Enterprise only). Filter by time range or by page/path (Assistant and Search are always site-wide). Mintlify keeps analytics data and assistant conversations for 365 days, so **All time** covers at most the last 365 days.
- CSV export: select **Export to CSV**, pick traffic, referrals, assistant conversations, searches, or feedback; Mintlify emails a link. Uses the selected time range. Assistant exports include `resolutionStatus` (`answered`/`unanswered`) and `feedback`.
- S3 streaming (Enterprise only): org admins configure destinations, categories, and projects at https://app.mintlify.com/settings/organization/streaming. Nothing streams until at least one category and one project are selected.

Check warning on line 36 in mint-instructions/publish/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/publish/analytics.mdx#L36

In general, use active voice instead of passive voice ('are selected').

## Feedback

- Enable feedback types in the dashboard: **Site** settings (https://app.mintlify.com/settings/project/site), **Feedback** section: thumbs rating, edit suggestions and raise issues (public repos only), contextual feedback (optional email), code snippet feedback.
- Agent feedback (beta): agents connected to the site's search MCP server call the `submit_feedback` tool with a page path and a problem description. Each accepted submission records as unhelpful feedback on that page and shows in **Detailed feedback** (filter Type: Agent feedback). Web search and web fetch tools do not reach this tool. The path must match a page or a redirect source, or the call errors.
- The analytics feedback API endpoint returns agent feedback with `source=agent` (https://www.mintlify.com/docs/api/analytics/feedback).

Check warning on line 42 in mint-instructions/publish/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/publish/analytics.mdx#L42

Use 'API' instead of 'api'.
- Assistant thumbs ratings are separate (Assistant satisfaction), not page feedback.

## Rules
Expand Down Expand Up @@ -85,8 +85,8 @@
}
```

- `cookies`: telemetry is disabled for visitors whose local storage lacks that key/value.

Check warning on line 88 in mint-instructions/publish/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/publish/analytics.mdx#L88

In general, use active voice instead of passive voice ('is disabled').
- Transcend: analytics and feedback load only after consent for the purpose (default `Analytics`). Mintlify's own banner is hidden.

Check warning on line 89 in mint-instructions/publish/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/publish/analytics.mdx#L89

In general, use active voice instead of passive voice ('is hidden').
- Osano has no docs.json key. Create `osano.js` in the content directory (auto-included on every page):

```js
Expand All @@ -112,4 +112,4 @@
- https://www.mintlify.com/docs/analytics
- https://www.mintlify.com/docs/optimize/feedback
- https://www.mintlify.com/docs/integrations/analytics/overview
- https://www.mintlify.com/docs/cli/commands

Check warning on line 115 in mint-instructions/publish/analytics.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

mint-instructions/publish/analytics.mdx#L115

Use 'CLI' instead of 'cli'.
Loading