---
title: "App-wide usage, revenue and margin"
method: GET
path: "/api/v1/admin/overview"
tags: ["admin"]
---

# App-wide usage, revenue and margin

`GET /api/v1/admin/overview`

## Request

- Base URL: `https://api.cadencz.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.cadencz.com/api/v1/admin/overview`
- Auth: HTTP bearer

Admin-only summary: accounts, subscriptions, credit and model spend, the per-plan margin model, and how each channel is actually being used.

## Response `200`

Successful Response

- AdminOverviewResponse
  - `users` integer, required
  - `admins` integer, required
  - `workspaces` integer, required
  - `active_subscriptions` integer, required
  - `model_runs` integer, required
  - `monthly_ai_generations_used` integer, required
  - `credits_granted` integer, required
  - `credits_used` integer, required
  - `credit_balance` integer, required
  - `estimated_revenue_usd` number, required
  - `estimated_provider_cost_usd_micros` integer, required
  - `estimated_margin_usd_micros` integer, required
  - `current_month_actual` AdminFinancialPeriod, required
    - `period_start` string, nullable, required
    - `period_end` string, required
    - `recorded_revenue_usd_micros` integer, required
    - `model_cost_usd_micros` integer, required
    - `contribution_usd_micros` integer, required
    - `model_runs` integer, required
    - `recorded_payments` integer, required
  - `lifetime_actual` AdminFinancialPeriod, required
    - `period_start` string, nullable, required
    - `period_end` string, required
    - `recorded_revenue_usd_micros` integer, required
    - `model_cost_usd_micros` integer, required
    - `contribution_usd_micros` integer, required
    - `model_runs` integer, required
    - `recorded_payments` integer, required
  - `expected_vs_actual` AdminExpectedVsActual, required
    - `period_start` string, required
    - `as_of` string, required
    - `expected_full_month_cost_usd_micros` integer, required
    - `expected_cost_to_date_usd_micros` integer, required
    - `actual_cost_to_date_usd_micros` integer, required
    - `variance_usd_micros` integer, required
    - `actual_percent_of_expected` number, nullable, required
    - `basis` string, required
  - `config_version` integer, required
  - `plan_economics` AdminPlanEconomics[], required
    - `tier` string, required
    - `name` string, required
    - `monthly_price_usd_micros` integer, required
    - `yearly_price_usd_micros` integer, required
    - `premium_actions` integer, required
    - `plan_runs` integer, required
    - `posts_per_plan` integer, required
    - `planned_post_generations` integer, required
    - `total_ai_generations` integer, required
    - `remaining_ai_generations` integer, required
    - `x_posts` integer, required
    - `x_posts_with_links` integer, required
    - `channel_cap` integer, required
    - `active_x_accounts` integer, required
    - `ai_analytics_insights` integer, required
    - `ai_post_generation_cost_usd_micros` integer, required
    - `planner_cost_usd_micros` integer, required
    - `planner_recovery_cost_usd_micros` integer, required
    - `premium_planner_runs` integer, required
    - `x_publish_cost_usd_micros` integer, required
    - `x_entitlement_cost_usd_micros` integer, required
    - `ai_analytics_cost_usd_micros` integer, required
    - `estimated_provider_cost_usd_micros` integer, required
    - `estimated_margin_usd_micros` integer, required
    - `estimated_gross_margin_percent` number, required
    - `estimated_yearly_provider_cost_usd_micros` integer, required
    - `estimated_yearly_margin_usd_micros` integer, required
    - `estimated_yearly_gross_margin_percent` number, required
    - `over_allocated` boolean, required
    - `excludes_infrastructure` boolean, required
    - `forecast_basis` string, required
    - `observed_ai_unit_cost_usd_micros` integer, required
    - `observed_model_runs` integer, required
  - `plan_adoption` AdminPlanAdoption[], required
    - `tier` string, required
    - `name` string, required
    - `enabled` boolean, required
    - `purchasable` boolean, required
    - `active_subscriptions` integer, required
    - `trialing` boolean
  - `channels` AdminChannelUsage[], required
    - `platform` string, required
    - `enabled` boolean, required
    - `connect_enabled` boolean, required
    - `publish_enabled` boolean, required
    - `connected_accounts` integer, required
    - `workspaces` integer, required
    - `published_this_month` integer, required
  - `workspaces_usage` AdminWorkspaceUsage[], required
    - `workspace_id` string, required
    - `workspace_name` string, required
    - `owner_email` string, nullable, required
    - `tier` string, nullable, required
    - `status` string, nullable, required
    - `monthly_ai_generations_used` integer, required
    - `monthly_ai_generations_cap` integer, required
    - `credits_granted` integer, required
    - `credits_used` integer, required
    - `credit_balance` integer, required
    - `model_runs` integer, required
    - `provider_cost_usd_micros` integer, required
    - `estimated_revenue_usd` number, required

## Other responses

- `401`: Missing or invalid Supabase bearer token.

---

[API](https://skmtc.dev/cadencz/apis/cadencz-api.md) · [All operations](https://skmtc.dev/cadencz/apis/cadencz-api/llms.txt) · [OpenAPI document](https://skmtc.dev/cadencz/apis/cadencz-api/revisions/3392fe5e93db?raw)