Skip to main content

​
Schema introspection

Every command below with arguments supports two read-only flags for tooling and AI agents:
  • --show-file-schema: print the JSON Schema for the full request object (the format --filename accepts).
  • --show-argument-schema <flag-name>: print the JSON Schema for one argument’s value. Pass the kebab flag name without the leading -- (e.g. org-id, not --org-id).
Both write pure JSON to stdout and never call the API. They cannot be combined with any other command-specific flag.

​
get

Get usage for a date range Return an organization’s usage for [start_date, end_date), in one bucket per calendar month, clipped to the range and ending at the current month. The organization is identified by the org_id path parameter alone; the x-hh-org-id header does not participate. An event counts in the month that contains its start_time, which the client sets when it logs the event, so usage for a past month can still grow. metrics_computed_count is the number of metrics.* keys on those events. Results are always split by event_type; pass group_by to also split them by workspace or by project. Every row is returned in one response; there is no pagination. Quarter- and year-to-date totals are for the caller to sum across ranges.

​
Usage

Accepted keys: Control plane fine-grained API key

​
Options

Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.

​
current

Get current usage counts Return an organization’s current counts, independent of any date range: members who completed onboarding, and non-archived workspaces and projects. The organization is identified by the org_id path parameter alone; the x-hh-org-id header does not participate.

​
Usage

Accepted keys: Control plane fine-grained API key

​
Options

Also supports --show-file-schema, --show-argument-schema <flag-name>, and --filename. See Schema introspection for details.