---
title: "Read the account dashboard aggregate"
method: GET
path: "/overview"
tags: ["Overview"]
---

# Read the account dashboard aggregate

`GET /overview`

## Request

- Base URL: `https://api.flashdata.dev/v2`
- URL: `https://api.flashdata.dev/v2/overview`
- Auth: API key in cookie `__Host-fd_session`

## Response `200`

Account-scoped overview

- ConsoleOverview
  - `account` Account, required: Deleted accounts are only returned through authorized Admin projections; their identity fields are redacted.
    - `id` string, required
    - `name` string, required
    - `email` string, email, nullable, required
    - `status` 'pending_verification' | 'active' | 'suspended' | 'deleting' | 'deleted', required
    - `emailVerified` boolean, required
    - `legalAcceptanceRequired` boolean, required
    - `role` 'user' | 'admin', required
    - `timezone` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `onboarding` OnboardingProgress, required
    - `currentStep` 'welcome' | 'api_key' | 'first_request' | 'completed', required
    - `useCase` 'google_search' | 'youtube_data' | 'download' | 'null', nullable
    - `apiKeyStepStatus` 'pending' | 'created' | 'skipped', required
    - `firstRequestStatus` 'pending' | 'succeeded' | 'skipped', required
    - `firstApiKeyId` string, nullable
    - `firstRequestId` string, nullable
    - `completedAt` string, date-time, nullable
    - `version` integer, required
    - `updatedAt` string, date-time, required
  - `subscription` Subscription, required: Effective entitlement projection. `status=payg` and `id=null` means no billing subscription record exists.
    - `id` string, nullable
    - `status` 'payg' | 'trialing' | 'active' | 'past_due' | 'grace' | 'cancelled', required
    - `plan` Plan, required
      - `id` string, required
      - `slug` string, required
      - `name` string, required
      - `description` string, required
      - `includedCredits` number, required: Credits included in each paid subscription cycle; zero for Pay As You Go.
      - `limits` PlanLimits, required
        - `concurrency` integer, required
        - `maxBatchSize` integer, required
        - `maxPendingJobs` integer, required
      - `prices` PlanPrice[], required
        - `id` string, required
        - `currency` 'USD', required
        - `unitAmount` integer, required: USD cents
        - `credits` number, required: Credits granted by a successful one-time top-up; zero for recurring prices.
        - `type` 'recurring' | 'one_time', required
        - `interval` 'month' | 'year' | 'null', nullable, required
      - `features` string[], required
      - `usagePrices` PlanUsagePrices, required
        - `googlePer1kCents` integer, required: Google request price per 1,000 successful requests, in USD cents.
        - `youtubePer1kCents` integer, required: Standard YouTube request price per 1,000 successful requests, in USD cents.
        - `downloadPerTbCents` integer, required: Download price per decimal TB (1,000,000,000,000 bytes), in USD cents.
    - `usageRates` object, required: Account-specific configured credit rates. Query rates come from the account entitlement, not the public plan catalog. One TB is 1,000,000,000,000 bytes; download charges are settled against actual bytes and rounded per result.
      - `customized` boolean, required: True when an administrator configured rates for this account.
      - `queries` object[], required
        - `source` string, required
        - `name` string, required
        - `creditsPerRequest` number, required
      - `downloadCreditsPerTb` number, required
    - `currentPeriodStart` string, date-time, nullable
    - `currentPeriodEnd` string, date-time, nullable
    - `cancelAtPeriodEnd` boolean, required
    - `graceEndsAt` string, date-time, nullable
  - `balance` CreditBalance, required
    - `balanceCredits` number, required: Signed settled balance after grants, usage, refunds and provider reversals.
    - `reservedCredits` number, required
    - `availableCredits` number, required: max(balanceCredits, 0).
    - `lifetimeGrantedCredits` number, required
    - `lifetimeUsedCredits` number, required
    - `lifetimeRefundedCredits` number, required: Credits returned to the account after failed usage.
    - `lifetimePaymentReversedCredits` number, required: Absolute Credits removed after verified provider refunds or chargebacks.
    - `updatedAt` string, date-time, required
  - `publicStatus` PublicStatus, required
    - `status` 'healthy' | 'degraded' | 'outage', required
    - `updatedAt` string, date-time, required
    - `components` PublicStatusComponent[], required
      - `id` string, required
      - `name` string, required
      - `status` 'operational' | 'degraded' | 'outage', required
  - `degradedSections` string[], required: A listed section uses its unavailable representation; null and empty values must not be interpreted as zero or healthy.
  - `generatedAt` string, date-time, required

## Other responses

- `401`: Authentication required or invalid
- `500`: An unexpected internal error occurred
- `503`: A required dependency or onboarding record is temporarily unavailable

---

[API](https://skmtc.dev/flashdata/apis/flashdata-customer-api.md) · [All operations](https://skmtc.dev/flashdata/apis/flashdata-customer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/flashdata/apis/flashdata-customer-api/revisions/109179fe9313?raw)