Heatmaps

Sampled clicks of a heatmap

A uniform random sample of the cohort's clicks, at most 2000. Recording IDs are included only for callers with the replay scope.

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}/clicks

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}/clicks
  • 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.

Query parameters

limitinteger

Most clicks to return.

Response

The sampled clicks.

keystring required
totalinteger required

Every click in the cohort, including any recorded before sampling began.

capacityinteger required

Changes

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