---
title: "Get per-workspace usage breakdown for a dimension."
method: GET
path: "/usage/v2/usage-workspace-breakdown/"
tags: ["usage"]
---

# Get per-workspace usage breakdown for a dimension.

`GET /usage/v2/usage-workspace-breakdown/`

## Request

- Base URL: `http://localhost:8000`
- URL: `http://localhost:8000/usage/v2/usage-workspace-breakdown/`
- Auth: one of:
  - API key in header `X-Api-Key`
  - API key in header `X-Secret-Key`

Query params:
    dimension: required
    period: YYYY-MM (default: current month)
    period_end: YYYY-MM (optional; defaults to period for a single month)

## Query parameters

- `dimension` string, required
- `period` string
- `period_end` string

## Response `200`

OK

- UsageWorkspaceBreakdownResponse
  - `status` boolean, required
  - `result` UsageWorkspaceBreakdownResult, required
    - `dimension` string, required
    - `period` string, required
    - `period_end` string, required
    - `workspaces` UsageWorkspaceBreakdownItem[], required
      - `workspace_id` string, uuid, nullable
      - `workspace_name` string, required
      - `usage` number, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `402`: Payment Required
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error
- `default`: Default error response

---

[API](https://skmtc.dev/futureagi/apis/future-agi-management-api.md) · [All operations](https://skmtc.dev/futureagi/apis/future-agi-management-api/llms.txt) · [OpenAPI document](https://skmtc.dev/futureagi/apis/future-agi-management-api/revisions/c8684118e142?raw)