---
title: "Get schedule heatmap data (appointment density by day/hour)"
method: GET
path: "/Metrics/schedule-heatmap"
tags: ["Metrics"]
---

# Get schedule heatmap data (appointment density by day/hour)

`GET /Metrics/schedule-heatmap`

## Request

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

## Query parameters

- `period` string

## Response `200`

OK

- BusinessMetricsResponseDtoOfScheduleHeatmapDto
  - `success` boolean
  - `data` ScheduleHeatmapDto
    - `data` HeatmapDataPointDto[]
      - `day` string
      - `hour` union
        - integer
        - string, int32
      - `value` union
        - integer
        - string, int32
    - `maxValue` union
      - integer
      - string, int32
    - `period` string
  - `error` string, nullable
  - `message` string, nullable

## Other responses

- `500`: Internal Server Error

---

[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)