---
title: "Return hosted Workbench overview dashboard state"
method: GET
path: "/workbench/overview"
---

# Return hosted Workbench overview dashboard state

`GET /workbench/overview`

## Request

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

Aggregates tenant plan, subscription, account scope, connections, data freshness, ETL watermarks and usage for the customer Workbench without returning raw secrets.

## Query parameters

- `usage_date` string: YYYY-MM-DD
- `platform` string
- `account_id` string
- `etl_limit` integer
- `include_bootstrap_detail` boolean

## Response `200`

Workbench overview

- object
  - `status` 'workbench_overview_ready', required
  - `tenant_id` string, required
  - `hosted_auth_context` object, required
  - `plan` object, required
  - `subscription` object, required
    - `status` string, required
    - `source` string
    - `tenant_id` string, required
    - `subscription_count` integer, required
    - `database_url_configured` boolean
    - `default_plan_id` string
    - `plan` object
    - `subscriptions` object[], required
      - `id` string, required
      - `tenant_id` string, required
      - `plan_id` string, required
      - `provider` string, required
      - `status` string, required
      - `currency` string
      - `current_period_start` string
      - `current_period_end` string
      - `cancel_at_period_end` boolean
      - `trial_start` string
      - `trial_end` string
      - `created_at` string
      - `updated_at` string
      - `provider_customer_id_present` boolean, required
      - `provider_customer_id_hash` string, required: Short SHA-256 hash prefix; raw cus_* ids are not returned.
      - `provider_subscription_id_present` boolean, required
      - `provider_subscription_id_hash` string, required: Short SHA-256 hash prefix; raw provider subscription ids are not returned.
    - `raw_provider_ids_returned` false, required
    - `raw_secrets_returned` false, required
  - `account_scope` object, required
    - `account_permission_count` integer, required
    - `account_permissions` object[], required
    - `source` string, required
  - `connections` object, required
    - `status` string
    - `connection_count` integer
    - `platform_account_count` integer
    - `visible_platform_account_count` integer
    - `discovered_platform_account_count` integer
    - `over_limit_platform_account_count` integer
    - `plan_account_limit` object
    - `account_scope_count` integer
    - `platform_accounts` object[]
    - `database_url_configured` boolean
  - `freshness` object, required
  - `etl_status` object, required
    - `status` string
    - `run_count` integer
    - `runs` object[]
    - `watermark_count` integer
    - `watermarks` object[]
    - `database_url_configured` boolean
  - `usage` object, required
  - `readiness` object, required
    - `status` string
    - `operational_state` string
    - `missing_setup_items` string[]
    - `database_url_configured` boolean
  - `ui_contract` object, required
    - `surface` 'ads_quant_workbench', required
    - `default_tab` string, required
    - `read_only` true, required
    - `writes_platform` false, required
    - `sections` string[]
  - `raw_secrets_returned` false, required
  - `writes_platform` false, required

## Other responses

- `403`: Workbench is not enabled for the current plan

---

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