---
title: "Get integrator consumption dashboard"
method: GET
path: "/integrator/dashboard"
tags: ["dashboard"]
---

# Get integrator consumption dashboard

`GET /integrator/dashboard`

Returns an aggregated view of the integrator's consumption:
- Total tokens used / limit / remaining for the current billing period
- Usage percentage and days remaining
- Top 10 workspaces by token consumption
- Plan information (if applicable)

Use this endpoint to build consumption dashboards in your frontend.

## Response `200`

Successful Response

- DashboardResponse — Aggregated consumption dashboard for an integrator. Composes data from usage tracking, token quota, and workspace management into a single convenient response.
  - `integrator_id` string, uuid, required
  - `integrator_name` string
  - `plan` string, nullable — Current plan (free/startup/growth/scale)
  - `period` string, required — Current billing period (YYYYMM)
  - `total_tokens_used` integer
  - `total_tokens_limit` integer, nullable — Monthly token limit. None if unlimited.
  - `tokens_remaining` integer, nullable — Tokens remaining. None if unlimited.
  - `usage_percentage` number, nullable — Usage as percentage (0-100). None if unlimited.
  - `bonus_tokens` integer
  - `days_remaining_in_period` integer, required
  - `total_events` integer
  - `top_workspaces` WorkspaceDashboardSummary[] — Workspaces sorted by token consumption (top 10)
    - `workspace_id` string, uuid, required
    - `workspace_name` string
    - `total_tokens` integer — Total tokens consumed this period
    - `total_events` integer — Number of usage events
    - `pots_count` integer — Number of POTs in this workspace

---

[API](https://skmtc.dev/scipot/apis/scipot-core-api.md) · [All operations](https://skmtc.dev/scipot/apis/scipot-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/scipot/scipot-core-api/revisions/e8712e9ffeae/schema)