Sign in

v2

latestOpenAPI 3.1.02026-08-0382170235.8 KB
dashboard

Get integrator consumption 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.

get/integrator/dashboard

Response

Successful Response

integrator_idstring uuid required
integrator_namestring
planstring nullable

Current plan (free/startup/growth/scale)

periodstring required

Current billing period (YYYYMM)

total_tokens_usedinteger
total_tokens_limitinteger nullable

Monthly token limit. None if unlimited.

tokens_remaininginteger nullable

Tokens remaining. None if unlimited.

usage_percentagenumber nullable

Usage as percentage (0-100). None if unlimited.

bonus_tokensinteger
days_remaining_in_periodinteger required
total_eventsinteger