---
title: "Get KPI summary with sparklines"
method: GET
path: "/Metrics/kpi-summary"
tags: ["Metrics"]
---

# Get KPI summary with sparklines

`GET /Metrics/kpi-summary`

## Request

- Base URL: `https://api.clinicos.vet/backend/business`
- URL: `https://api.clinicos.vet/backend/business/Metrics/kpi-summary`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/docs/Metrics/kpi-summary/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `period` string

## Response `200`

OK

- BusinessMetricsResponseDtoOfKPISummaryDto
  - `success` boolean
  - `data` KPISummaryDto
    - `revenue` KPIMetricDto
      - `today` union
        - number, double
        - string, double
      - `mtd` union
        - number, double
        - string, double
      - `change` union
        - number, double
        - string, double
      - `basis` string, nullable: What the figure measures, rendered on the tile. /bi ships several differently-based "revenue" numbers, and ACT in particular was being read as something it was not (ITE-774). Null where the tile's meaning is unambiguous.
    - `patients` KPIMetricDto
      - `today` union
        - number, double
        - string, double
      - `mtd` union
        - number, double
        - string, double
      - `change` union
        - number, double
        - string, double
      - `basis` string, nullable: What the figure measures, rendered on the tile. /bi ships several differently-based "revenue" numbers, and ACT in particular was being read as something it was not (ITE-774). Null where the tile's meaning is unambiguous.
    - `avgTransaction` KPIMetricDto
      - `today` union
        - number, double
        - string, double
      - `mtd` union
        - number, double
        - string, double
      - `change` union
        - number, double
        - string, double
      - `basis` string, nullable: What the figure measures, rendered on the tile. /bi ships several differently-based "revenue" numbers, and ACT in particular was being read as something it was not (ITE-774). Null where the tile's meaning is unambiguous.
  - `error` string, nullable
  - `message` string, nullable

## Other responses

- `500`: Internal Server Error

## Changes

- **2026-09-17** `d4ae30be0619`: 9 info
  - added the optional property `data/oneOf[#/components/schemas/KPISummaryDto]/avgTransaction/basis` to the response with the `200` status (media type: text/plain)
  - added the optional property `data/oneOf[#/components/schemas/KPISummaryDto]/avgTransaction/basis` to the response with the `200` status (media type: application/json)
  - added the optional property `data/oneOf[#/components/schemas/KPISummaryDto]/avgTransaction/basis` to the response with the `200` status (media type: text/json)
  - added the optional property `data/oneOf[#/components/schemas/KPISummaryDto]/patients/basis` to the response with the `200` status (media type: text/plain)
  - …5 more

[Operation history](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/changes/Metrics/kpi-summary/get.md)

---

[API](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1.md) - [All operations](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/revisions/099cf36186e0?raw)