Skip to content

Document Usage API groupBy of up to three dimensions - #1583

Open
CodesMcCabe wants to merge 4 commits into
mainfrom
cm/usage-api-multi-dimension-groupby
Open

Document Usage API groupBy of up to three dimensions#1583
CodesMcCabe wants to merge 4 commits into
mainfrom
cm/usage-api-multi-dimension-groupby

Conversation

@CodesMcCabe

Copy link
Copy Markdown
Contributor

Description

The Usage API time-series endpoint now accepts up to three groupBy dimensions. The published Admin API and CLI docs still said callers could group by one dimension.

This PR updates those prose pages so they match the API and the CLI/MCP clients.

The generated Get usage time series page comes from the live Usage API OpenAPI spec (https://admin-api.alchemy.com/v1/usage/openapi.json). That page updates after the Usage API change ships. This PR does not edit a checked-in spec.

Related Issues

LINEAR TASK: https://linear.app/alchemyapi/issue/DX-3488/multi-dimensional-grouping

Companion PRs:

Changes Made

  • Admin API overview: group usage by up to three dimensions
  • Admin API quickstart: same wording on the time-series example
  • Alchemy CLI tutorial: --group-by accepts up to three comma-separated dimensions, with a two-dimension example

Testing

  • Reviewed the wording against the Usage API contract (groupBy max 3 unique dimensions)
  • I have tested these changes locally
  • I have run the validation scripts (pnpm run validate)
  • I have checked that the documentation builds correctly

Created using the /git skill.
Co-Authored-By: Cursor Grok 4.6

Made with Cursor

The time-series API now accepts three group-by dimensions, so the Admin API and CLI docs no longer say one.

Co-authored-by: Cursor <cursoragent@cursor.com>
@CodesMcCabe
CodesMcCabe requested a review from a team as a code owner August 31, 2026 19:51
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Aug 31, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-08-31T19:54:36.538384Z be3fdd2 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@github-actions

github-actions Bot commented Aug 31, 2026

Copy link
Copy Markdown

🔗 Preview Mode

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview Sep 1, 2026, 9:23 PM

CodesMcCabe and others added 3 commits September 1, 2026 16:41
Split plan lookback from per-query span limits and describe cursor pagination
behavior for the Admin API and CLI.

Co-authored-by: Cursor <cursoragent@cursor.com>
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