Heatmaps

Get a heatmap

Click density grid, pointer dwell, most-clicked elements and scroll depth for one cohort.

Required token scopes are listed in x-hootlens-scopes. A signed-in person needs the matching permission on the site instead (the viewer and editor roles are presets of the permissions).

get/v1/projects/{projectId}/heatmaps/{key}

Request

Base URL: https://hootlens-api-368877148687.us-east1.run.app
URL: https://hootlens-api-368877148687.us-east1.run.app/v1/projects/{projectId}/heatmaps/{key}
Auth: HTTP bearer

Path parameters

projectIdstring required

An identifier: 1 to 80 letters, digits, underscores or hyphens.

The project ID. Project IDs are public identifiers, not secrets.

keystring required

A heatmap cohort key as returned by the heatmap list, URL-encoded. It is a JSON array naming the site (project), page group, page version, revision and device class.

Response

The heatmap.

keystring required

Cohort key. URL-encode it to use as a path parameter.

groupstring

pathstring required

buildIdstring required

pageVersionstring

revisionstring required

variantstring required

deviceClass'desktop' | 'tablet' | 'mobile' required

sessionsinteger required

segmentsinteger required

clicksinteger required

lastSeenAtinteger required

Epoch milliseconds.

docWidthinteger required

docHeightinteger required

scrollDepthsnumber[] required

Share of page views reaching each 10% band of the page; index 0 is the top.

Changes

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