---
title: "Preview"
method: GET
path: "/developer/settlement-metrics/preview"
tags: ["Developer", "Developer - Settlement Metrics"]
---

# Preview

`GET /developer/settlement-metrics/preview`

## 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/developer/settlement-metrics/preview`
- Auth: none declared

## Response `200`

Successful Response

- TvDashboardResponse
  - `generated_at` string, date-time, required
  - `source_synced_at` string, date-time, nullable
  - `timezone` string, required
  - `source_status` string, required
  - `siren_threshold` number, required
  - `teams` TeamScore[], required
    - `settled_today` integer
    - `settled_this_week` integer
    - `settled_this_month` integer
    - `settled_this_quarter` integer
    - `settled_this_year` integer
    - `entries_today` integer
    - `entries_this_week` integer
    - `entries_this_month` integer
    - `entries_this_quarter` integer
    - `entries_this_year` integer
    - `amount_today` number
    - `amount_this_week` number
    - `amount_this_month` number
    - `amount_this_quarter` number
    - `amount_this_year` number
    - `team_id` string, required
    - `team` string, required
    - `color` string, required
    - `pace_vs_last_month` integer
  - `totals` PeriodScore
    - `settled_today` integer
    - `settled_this_week` integer
    - `settled_this_month` integer
    - `settled_this_quarter` integer
    - `settled_this_year` integer
    - `entries_today` integer
    - `entries_this_week` integer
    - `entries_this_month` integer
    - `entries_this_quarter` integer
    - `entries_this_year` integer
    - `amount_today` number
    - `amount_this_week` number
    - `amount_this_month` number
    - `amount_this_quarter` number
    - `amount_this_year` number
  - `unaffiliated` PeriodScore
    - `settled_today` integer
    - `settled_this_week` integer
    - `settled_this_month` integer
    - `settled_this_quarter` integer
    - `settled_this_year` integer
    - `entries_today` integer
    - `entries_this_week` integer
    - `entries_this_month` integer
    - `entries_this_quarter` integer
    - `entries_this_year` integer
    - `amount_today` number
    - `amount_this_week` number
    - `amount_this_month` number
    - `amount_this_quarter` number
    - `amount_this_year` number
  - `month_progress` MonthProgressPoint[], required
    - `day` integer, required
    - `team` string, required
    - `cumulative` integer, required
    - `cumulative_amount` number, required
  - `month_comparison` MonthComparisonPoint[]
    - `day` integer, required
    - `this_month` number, nullable
    - `last_month` number, nullable
  - `last_month_leaderboard` LeaderboardEntry[], required
    - `rank` integer, required
    - `team` string, required
    - `color` string, required
    - `settlements` integer, required
    - `total_amount` number, required
    - `biggest_settlement` 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
  - `retained` RetainedCasesBoard: Firm-wide cases retained per period; retained cases are never split by team.
    - `cases_synced_at` string, date-time, nullable
    - `totals` RetainedScore, required
      - `retained_today` integer
      - `retained_this_week` integer
      - `retained_this_month` integer
      - `retained_this_quarter` integer
      - `retained_this_year` integer
    - `month_progress` RetainedProgressPoint[], required
      - `day` integer, required
      - `retained` integer, required
      - `cumulative` integer, required
    - `year_months` RetainedYearMonth[]
      - `month` integer, required
      - `retained` integer, nullable
      - `previous` integer
      - `two_years_ago` integer
    - `month_comparison` RetainedComparisonPoint[]
      - `day` integer, required
      - `this_month` integer, nullable
      - `last_month` integer, nullable

## Changes

- **2026-10-03** `d8e87bdbfbf2`: 3 breaking, 2 info
  - removed the required property `retained/anyOf[subschema #1: RetainedCasesBoard]/month_progress/items/team` from the response with the `200` status
  - removed the required property `retained/anyOf[subschema #1: RetainedCasesBoard]/teams` from the response with the `200` status
  - removed the required property `retained/anyOf[subschema #1: RetainedCasesBoard]/unaffiliated` from the response with the `200` status
  - added the optional property `retained/anyOf[subschema #1: RetainedCasesBoard]/year_months` to the response with the `200` status
  - …1 more
- **2026-10-02** `cbec4df5dc85`: 1 info
  - added the optional property `retained` to the response with the `200` status
- **2026-09-29** `318400082d74`: 9 info
  - added the optional property `month_comparison` to the response with the `200` status
  - added the optional property `teams/items/amount_this_quarter` to the response with the `200` status
  - added the optional property `teams/items/amount_this_year` to the response with the `200` status
  - added the optional property `teams/items/entries_this_quarter` to the response with the `200` status
  - …5 more
- **2026-09-17** `0afcd7c31ce2`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/openintake/apis/openintake-api/changes/developer/settlement-metrics/preview/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)