Document Usage APIs used in the Dashboard

[benitav]

https://journeyapps.slack.com/archives/C07T28DRV5E/p1782913246946739

For now this will be an unlisted page.

🤖 The page was primarily written by Claude Code after passing it the powersync-usage and powersync-dashboard repos as reference. I then tested the documented APIs via Insomnia, passing Claude the results to verify accuracy.

[mintlify]

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

Project	Status	Preview	Updated (UTC)
powersync	🟢 Ready	View Preview	Jul 2, 2026, 12:01 PM

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

[claude]

Documentation review: maintenance-ops/usage-metrics-api.mdx

Assessment: Approve with minor fixes

Reviewed against the checklist in .claude/agents/document-reviewer.md / CLAUDE.md. This is a new, well-organized reference page; scope was limited to the added content.

Issues (posted inline)

• Three raw code blocks are missing a language tag (Authorization: Bearer <token> and the two POST .../usage/... endpoint blocks) — CLAUDE.md "Code Examples" requires a language tag on every block.
• The intro links to the monitoring page's "Metrics view," but the target section is titled "Usage Metrics" there (and is referred to that way elsewhere on that page). Minor wording mismatch worth aligning.

Other checklist items — no issues found

• Frontmatter: title/description present, no duplication with the opening paragraph, hidden: true is a valid documented pattern for pages intentionally excluded from sidebar nav (doesn't need a docs.json entry).
• Headings: Title Case throughout, hierarchy starts at H2, no verb-first headings.
• Voice/tone: second person, active voice, no filler words, no editorializing, no promotional language.
• No dash-joined clauses in prose.
• No unnecessary bold.
• Components: <Warning> and <Note> used appropriately; no procedural steps that would warrant <Steps>.
• Links: all internal links are relative; external links (dashboard, curl endpoints) are appropriately absolute.
• Sync Streams/Sync Rules: not applicable to this page.
• SQL aliasing: not applicable, no SQL examples.

Caveat

This documents a new early-access API. I can't independently verify the endpoint behavior described (e.g., the granularity/window-alignment rules, the minute 24-hour cap, archived-vs-live data handling) against the actual service — that verification should come from whoever implemented or tested the API.