---
title: "Get Overview"
method: GET
path: "/admin/finance/overview"
tags: ["admin"]
---

# Get Overview

`GET /admin/finance/overview`

## Request

- Base URL: `https://api.framesail.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.framesail.com/admin/finance/overview`
- Auth: HTTP bearer

## Query parameters

- `start` string, date, nullable: Inclusive start date (YYYY-MM-DD)
- `end` string, date, nullable: Inclusive end date (YYYY-MM-DD)

## Response `200`

Successful Response

- HeadlineTotals
  - `start` string, required
  - `end` string, required
  - `our_cost_usd` number, required
  - `byok_cost_usd` number, required
  - `revenue_mrr_usd` number, required
  - `revenue_topup_usd` number, required
  - `total_revenue_usd` number, required
  - `margin_usd` number, required
  - `op_count` integer, required
  - `byok_op_count` integer, required
  - `distinct_users` integer, required

## Other responses

- `422`: Validation Error

---

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