> ## Documentation Index
> Fetch the complete documentation index at: https://docs.checkthatfield.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Admin overview

> The admin page for the Check That Field team: who can open it and what each tab is for.

> [!NOTE]
>
> These pages are for the Check That Field team. Partners don't have admin access: they get keys from us by email.

The admin page is at [www.checkthatfield.com/admin](https://www.checkthatfield.com/admin).

## Who can open it

Sign in with your Check That Field account. The page opens only for accounts whose email is on the team's admin list. Anyone else sees a sign-in form, or "*email* cannot open this page" with a **Sign out** button. To be added to the list, ask whoever looks after the service.

## The tabs

The page has five tabs. The address remembers the tab you are on (`/admin#keys`, `/admin#metrics`), so a reload or a shared link opens the same one.

> [accordion] Pipelines
>
> How we read the councils' planning registers. Tiles across the top count the records held and the pipelines by status (Healthy, Running, Failing, Blocked, Slowed down, Off). Charts show the last 30 days, and how fast the pipelines are reading. The table below has one row per council portal: its status, when it last worked and will next, records held and located, and how far back its history goes. **Run failed** retries every failing pipeline at once. The page refreshes itself.

> [accordion] Map
>
> A map of England's councils, shaded by how much of each one's planning register we hold. Grey means nothing yet.

> [accordion] Demand
>
> Where people search and order reports, over the last 7, 30 or 90 days, and what we lack there now (no fields, no Local Plan, no plan sites, no register, no supply figures). Councils are ranked by searches, with a report counting as three. Crawlers are left out of the counts. Use it to decide what to load next. Widget and API lookups aren't counted here.

> [accordion] Metrics
>
> How big the platform is and how it is growing, counted every hour. See [Metrics](https://docs.checkthatfield.com/admin/metrics.md).

> [accordion] Keys
>
> Partners' keys for the API and the widget: make one, see how much each has been used this month, and revoke one. See [Keys](https://docs.checkthatfield.com/admin/keys.md).

## Common jobs

> [card] [Issue a key to a partner](https://docs.checkthatfield.com/admin/keys.md#issue-a-key)
>
> What to ask them, what to fill in, and what to send back.

> [card] [Revoke a key](https://docs.checkthatfield.com/admin/keys.md#revoke-a-key)
>
> When a key leaks or a partner leaves.

> [card] [Check a partner's usage](https://docs.checkthatfield.com/admin/keys.md#read-usage)
>
> Calls against quota, widget views and clicks.

> [card] [Read the numbers](https://docs.checkthatfield.com/admin/metrics.md)
>
> What each tile on the Metrics tab means.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.