Heatmap

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

`GET`
`GET`
`PATCH`

Retrieve heatmap capture pages

Required API key scopes

project:read

Response

Example request

GET /api/projects/:project_id/heatmap_capture/pages
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/heatmap_capture/pages/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/heatmap_capture/pages/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "pages": [
    {
      "url": "string",
      "count": 0
    }
  ]
}

Retrieve heatmap capture settings

Required API key scopes

project:read

Response

Example request

GET /api/projects/:project_id/heatmap_capture/settings
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/heatmap_capture/settings/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/heatmap_capture/settings/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "capture_mode": "all",
  "url_allowlist": [
    "string"
  ],
  "enforcement_enabled": true,
  "can_capture_all_urls": true,
  "capture_url_limit": 0
}

Update heatmap capture settings

Required API key scopes

project:write

Request parameters

capture_mode
url_allowlist
array

Response

Example request

PATCH /api/projects/:project_id/heatmap_capture/settings
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/heatmap_capture/settings/\
	-d capture_mode=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/heatmap_capture/settings/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "capture_mode": "all",
  "url_allowlist": [
    "string"
  ],
  "enforcement_enabled": true,
  "can_capture_all_urls": true,
  "capture_url_limit": 0
}