> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeyhive.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Usage

> Read an organization's usage: events and computed metrics per calendar month, and current user, workspace and project counts.

## 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

```sh theme={null}
honeyhive usage get [options]
```

**Accepted keys:** [Control plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

### Options

| Flag | Type | Required | Description |
| - | - | - | - |
| `--end-date` | string | yes | Exclusive end, `YYYY-MM-DD` (UTC), 1 to 92 days after `start_date` |
| `--org-id` | string | yes | The unique identifier of the organization |
| `--start-date` | string | yes | Inclusive start, `YYYY-MM-DD` (UTC), no later than today |
| `--group-by` | string | no | Split results by workspace, or by project (each project row also carries its workspace) Allowed: `workspace_id`, `project_id`. |

Also supports `--show-file-schema`, `--show-argument-schema <flag-name>`, and `--filename`. See [Schema introspection](#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

```sh theme={null}
honeyhive usage current [options]
```

**Accepted keys:** [Control plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

### Options

| Flag | Type | Required | Description |
| - | - | - | - |
| `--org-id` | string | yes | The unique identifier of the organization |

Also supports `--show-file-schema`, `--show-argument-schema <flag-name>`, and `--filename`. See [Schema introspection](#schema-introspection) for details.


## Related topics

- [Usage](https://docs.honeyhive.ai/v2/workspace/usage.md)
- [Usage Methods](https://docs.honeyhive.ai/v2/control-plane-sdk-reference/typescript/ref/usage/index.md)
- [Get usage for a date range](https://docs.honeyhive.ai/v2/control-plane-api-reference-autogen/usage/get-usage-for-a-date-range.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.