---
title: "Overview"
method: GET
path: "/api/v1/admin/overview"
---

# Overview

`GET /api/v1/admin/overview`

## Request

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

## Query parameters

- `feed_id` string, nullable

## Response `200`

Successful Response

- AdminOverview
  - `feeds` FeedSummary[], required
    - `id` string, required
    - `brand` string, required
  - `sources` SourceSummary[], required
    - `id` string, required
    - `feed_id` string, required
    - `config` SourceDefinition, required
      - `name` string, required
      - `url` string, required
      - `allowed_hosts` string[], required
      - `adapter` 'OFFICIAL_DOCUMENT' | 'TEXAS_REGISTER_INDEX' | 'KREUZCRAWL' | 'HISTORICAL_INDEX' | 'TEXAS_TAC_BROWSER'
      - `format` 'auto' | 'html' | 'pdf' | 'pdf-zip' | 'docx' | 'xlsx' | 'texas-register' | 'rss' | 'tac-browser'
      - `stage` string
      - `selector` string, nullable
      - `paused` boolean
      - `canonical_owner_for_collection` string, nullable
      - `suppress_initial_notifications` boolean, nullable
      - `scope_rules` ScopeRule[]
        - `quote` string, required
        - `match` object, required
    - `checked_at` number, nullable, required
    - `failed` boolean, required
  - `current_record_counts` object, required
  - `lifecycle` object, required
  - `analysis_counts` object, required
  - `queue_counts` object, required
  - `recovery_jobs` object[], required
  - `source_runs` SourceRun[], required
    - `id` string, required
    - `source_id` string, required
    - `started_at` number, required
    - `finished_at` number, nullable, required
    - `state` string, required
    - `details` object, required
  - `model_key_configured` boolean, required
  - `model_usage` object, required
  - `email_health` object, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/getregisters/apis/obligation-register-api.md) · [All operations](https://skmtc.dev/getregisters/apis/obligation-register-api/llms.txt) · [OpenAPI document](https://skmtc.dev/getregisters/apis/obligation-register-api/revisions/244019325098?raw)