---
title: "Get usage metrics"
method: GET
path: "/billing/usage/metrics"
tags: ["Billing - Usage"]
---

# Get usage metrics

`GET /billing/usage/metrics`

Get usage metrics for the workspace

## Query parameters

- `workflowUuid` string, uuid — Filter metrics by workflow identifier.
- `modelUuid` string, uuid — Filter metrics by model identifier.
- `connectorUuid` string, uuid — Filter metrics by connector identifier.
- `integrationSlug` string — Filter metrics by integration slug.
- `slug` string — Filter metrics by slug.
- `agentUuid` string, uuid — Filter metrics by agent identifier.
- `from` string, required — Start of the time range.
- `to` string, required — End of the time range.
- `groupBy` 'integration_slug' | 'connector_uuid' | 'model_uuid' | 'workflow_uuid' | 'agent_uuid' — Group metrics by this dimension.
- `unit` 'billing.credits' | 'storage.records' | 'orchestration.executions' — Usage unit to report.

## Response `200`

Successful response

- object
  - `metrics` object[], required — Usage metrics for the selected range.
    - `date` string, required
    - `items` object[], required
      - `slug` string, required
      - `count` number, required
      - `groupBy` string, nullable, required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.net/getcargo/apis/cargo-api.md) · [All operations](https://skmtc.net/getcargo/apis/cargo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/getcargo/cargo-api/revisions/1d5a19e01d83/schema)