analytics

Click and scroll heatmap for one page and device class

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

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

Query parameters

sitestring required

Site id. Resolved against your access before it reaches any query; a site you cannot read answers 404, byte-identical to one that does not exist.

daysinteger

Window length in days.

pathstring
device'desktop' | 'tablet' | 'mobile'

Response

The heatmap and the query that chose the recordings.

Changes

No recorded changes to this operation across all 1 revision of this API.