---
title: "Settlement Dashboard"
method: GET
path: "/settlement-metrics/dashboard"
tags: ["Settlement Metrics"]
---

# Settlement Dashboard

`GET /settlement-metrics/dashboard`

## Request

- Base URL: `https://api.openintake.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.openintake.ai/settlement-metrics/dashboard`
- Auth: none declared

The TV's figures for the web app, over a preset or custom range in the reporting timezone.

## Query parameters

- `period` 'today' | 'week' | 'month' | 'quarter' | 'year' | 'custom'
- `start_date` string, date, nullable: First local day of a custom range (period=custom), inclusive
- `end_date` string, date, nullable: Last local day of a custom range (period=custom), inclusive

## Response `200`

Successful Response

- SettlementDashboardResponse: The web app's view of the TV figures over an arbitrary local-day range.
  - `period` 'today' | 'week' | 'month' | 'quarter' | 'year' | 'custom', required
  - `start_date` string, date, required
  - `end_date` string, date, required
  - `previous_start_date` string, date, required
  - `previous_end_date` string, date, required
  - `bucket` 'day' | 'week' | 'month', required
  - `timezone` string, required
  - `generated_at` string, date-time, required
  - `source_synced_at` string, date-time, nullable
  - `source_status` string, required
  - `major_threshold` number, required
  - `hide_last_month` boolean
  - `totals` SettlementTotals, required
    - `amount` number, required
    - `cases` integer, required
    - `entries` integer, required
    - `largest` number, required
  - `previous_totals` SettlementTotals, required
    - `amount` number, required
    - `cases` integer, required
    - `entries` integer, required
    - `largest` number, required
  - `unattributed` SettlementTotals, required
    - `amount` number, required
    - `cases` integer, required
    - `entries` integer, required
    - `largest` number, required
  - `teams` SettlementTeamSummary[], required
    - `team_id` string, required
    - `team` string, required
    - `color` string, required
    - `rank` integer, required
    - `current` SettlementTotals, required
      - `amount` number, required
      - `cases` integer, required
      - `entries` integer, required
      - `largest` number, required
    - `previous` SettlementTotals, required
      - `amount` number, required
      - `cases` integer, required
      - `entries` integer, required
      - `largest` number, required
  - `progress` SettlementProgressPoint[], required
    - `bucket_start` string, date, required
    - `team_id` string, required
    - `amount` number, required
    - `entries` integer, required
    - `cumulative_amount` number, required
  - `recent_activity` ActivityItem[], required
    - `event_id` string, required
    - `observed_at` string, date-time, required
    - `settled_at` string, date-time, required
    - `team` string, required
    - `color` string, required
    - `amount` number, required
    - `big` boolean, required
    - `alert_eligible` boolean

## Other responses

- `422`: Validation Error

## Changes

- **2026-09-30** `912982f625cd`: 2 warning, 2 info
  - added the new `quarter` enum value to the `period` response property for the response status `200`
  - added the new `year` enum value to the `period` response property for the response status `200`
  - added the new enum value `quarter` to the `query` request parameter `period`
  - added the new enum value `year` to the `query` request parameter `period`
- **2026-09-26** `7296f576bb94`: 1 info
  - added the optional property `hide_last_month` to the response with the `200` status
- **2026-09-25** `2874401d2b40`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/openintake/apis/openintake-api/changes/settlement-metrics/dashboard/get.md)

---

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