---
title: "List heatmap cohorts"
method: GET
path: "/v1/projects/{projectId}/heatmaps"
tags: ["Heatmaps"]
---

# List heatmap cohorts

`GET /v1/projects/{projectId}/heatmaps`

## Request

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

Heatmap cohorts, kept separate by page group, page version, revision and device class.

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

## Path parameters

- `projectId` string, required: An identifier: 1 to 80 letters, digits, underscores or hyphens.

## Response `200`

The cohorts.

- object
  - `cohorts` HeatmapCohortSummary[], required
    - `key` string, required: Cohort key. URL-encode it to use as a path parameter.
    - `group` string
    - `path` string, required
    - `buildId` string, required
    - `pageVersion` string
    - `revision` string, required
    - `variant` string, required
    - `deviceClass` 'desktop' | 'tablet' | 'mobile', required
    - `sessions` integer, required
    - `segments` integer, required
    - `clicks` integer, required
    - `lastSeenAt` integer, required: Epoch milliseconds.
    - `locales` object[]
      - `key` string
      - `segments` integer
      - `clicks` integer
    - `variants` object[]
      - `key` string
      - `segments` integer
      - `clicks` integer

## Other responses

- `401`: The credential is missing, expired or revoked.
- `403`: The credential or the person's permissions on the site do not permit this action.
- `404`: The site, or the record inside it, does not exist or the caller is not a member (a non-member cannot tell the two apart).
- `429`: A rate limit or a per-site limit was reached.

---

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