Skip to content

docs: add Usage Analytics page#11061

Open
keydunov wants to merge 2 commits into
masterfrom
docs/usage-analytics
Open

docs: add Usage Analytics page#11061
keydunov wants to merge 2 commits into
masterfrom
docs/usage-analytics

Conversation

@keydunov

Copy link
Copy Markdown
Member

Check List

  • Tests have been run in packages where changes have been made if available
  • Linter has been run for changed code
  • Tests for the changes have been added if not covered yet
  • Docs have been added / updated if required

Description of Changes Made

Adds a docs page for the Usage Analytics feature under Admin → Monitoring, plus its navigation entry in docs.json (first item of the Monitoring group).

The page covers:

  • The four pre-built dashboards (Overview, Query Activity & Performance, Users & Adoption, AI & Token Tracking) as a name + one-line-description table — intentionally light on per-chart detail since dashboard contents may still change.
  • Building custom dashboards on the three curated usage views (API Requests, AI Usage, Users & Adoption), being explicit that Usage Analytics is the full Cube application embedded via Creator Mode, with a link to the Creator Mode page.
  • Plan availability (Premium and above) and admin-only access, using the standard <Note> callout pattern.
  • Data freshness (slight delay; Query History for real-time) and isolation from customer content.

Notes for the reviewer

  • A screenshot TODO placeholder is left in place until the UI is final.
  • Docs-only change; docs.json validated as JSON and verified locally with the Mintlify dev server.

🤖 Generated with Claude Code

Document the Usage Analytics feature: pre-built dashboards (Overview,
Query Activity & Performance, Users & Adoption, AI & Token Tracking),
building custom dashboards on the curated usage views via Creator Mode,
plan availability, and data freshness/isolation caveats.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
cubed3 🟢 Ready View Preview Jun 11, 2026, 12:00 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@claude

claude Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Claude finished @keydunov's task in 31s —— View job


Code Review

  • Read changed files
  • Verify internal links resolve
  • Check Mintlify conventions
  • Post review

Verdict: LGTM — ship it. Docs-only change, follows docs-mintlify/CLAUDE.md conventions, internal links resolve, docs.json is valid JSON with the page registered at the top of the Monitoring group as described.

Review details (0 high, 0 medium, 3 nits)

What's good

  • Frontmatter uses title + description; no body H1 (matches convention).
  • Root-relative internal links — /embedding/iframe/creator-mode and /admin/monitoring/query-history both resolve to existing files.
  • <Note> callout used for plan/access constraints (standard pattern).
  • Screenshot placeholder uses the {/* TODO: screenshot — ... */} form documented in docs-mintlify/CLAUDE.md.
  • Tables are scannable; "Pre-built dashboards" intentionally light on per-chart detail as noted in PR body — reasonable while the UI is in flux.

Nits (non-blocking)

  1. docs-mintlify/admin/monitoring/usage-analytics.mdx:46 — the "Build your own dashboards" intro says "the same three curated views that power the pre-built ones", but the dashboards section above lists four dashboards without naming the underlying views. A one-line bridge ("the three views below power all four dashboards above") would make the relationship explicit.
  2. docs-mintlify/admin/monitoring/usage-analytics.mdx:50 — the view name Users & Adoption is identical to the dashboard name in the table above. Worth confirming that's intentional (view and dashboard sharing a name) vs. a naming collision worth disambiguating before publication.
  3. docs-mintlify/admin/monitoring/usage-analytics.mdx:19 — minor: "only available to account administrators" inside a <Note> reads more like a <Warning> (access restriction). Either is fine; flagging only because access-control facts often use <Warning> elsewhere in these docs.

Not reviewed (out of scope for a docs-only PR): tests, security, performance.

• `docs/usage-analytics`

@claude

claude Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Claude finished @vasilev-alex's task in 50s —— View job


Code Review (sync update)

Verdict: LGTM — ship it. New commit replaces the screenshot TODO with a real <Frame> containing light/dark variants — matches the convention used in 20+ other Mintlify pages (lgo0ecceic.ucarecd.net is the Cube-specific Uploadcare CDN subdomain). All prior review points still apply unchanged.

Review details (0 high, 0 medium, 3 nits — same as initial review)

Latest commit (bd0e6c4 "screenshots")

  • docs-mintlify/admin/monitoring/usage-analytics.mdx:27-38 — replaces {/* TODO: screenshot */} with a <Frame> block providing both block dark:hidden and hidden dark:block <img> variants. Alt text matches across both. Convention is consistent with existing pages.

What's good (unchanged from initial review)

  • Frontmatter uses title + description; no body H1.
  • Root-relative internal links resolve (/embedding/iframe/creator-mode, /admin/monitoring/query-history).
  • <Note> callout for plan/access constraints.
  • Tables are scannable.

Nits (non-blocking, carried over)

  1. usage-analytics.mdx:57 (was :46) — "Build your own dashboards" intro mentions "the same three curated views that power the pre-built ones", but the dashboards section lists four dashboards without naming the underlying views. A one-line bridge would make the relationship explicit.
  2. usage-analytics.mdx:61 (was :50) — view name Users & Adoption is identical to the dashboard name above. Confirm intentional vs. naming collision.
  3. usage-analytics.mdx:19 — "only available to account administrators" in a <Note> could be a <Warning> since it's an access restriction; access-control facts often use <Warning> elsewhere.

Not reviewed: tests, security, performance (docs-only PR).

• `docs/usage-analytics`

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants