---
title: "Click and scroll heatmap for one page and device class"
method: GET
path: "/api/heatmap"
tags: ["analytics"]
---

# Click and scroll heatmap for one page and device class

`GET /api/heatmap`

## Request

- Base URL: `https://app.vitrus.dev/app`
- URL: `https://app.vitrus.dev/app/api/heatmap`
- Auth: one of:
  - API key in cookie `vitrus_session`
  - HTTP bearer

Built from the site's session recordings (nothing extra is collected): clicked cells as [x share of width, y px, clicks], scroll reach per 100 px, the recorded pages for the picker and the latest masked snapshot to draw on. A sample — recorded visits only. Members only; on the cloud a Pro feature (402 with reason "plan" below it).

## Query parameters

- `site` string, required
- `days` integer
- `path` string
- `device` 'desktop' | 'tablet' | 'mobile'

## Response `200`

The heatmap and the query that chose the recordings.

## Other responses

- `402`: Not on a plan with heatmaps.

---

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