Heatmap

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

Endpoints

`GET`
`PATCH`

Retrieve heatmap screenshot settings

Required API key scopes

project:read

Response

Example request

GET /api/projects/:project_id/heatmap_screenshot/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_screenshot/settings/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/heatmap_screenshot/settings/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "allowed_hostnames": [
    "string"
  ],
  "cookie_delivery_enabled": true,
  "has_secret": true
}

Update heatmap screenshot settings

Required API key scopes

project:write

Request parameters

allowed_hostnames
array

Response

Example request

PATCH /api/projects/:project_id/heatmap_screenshot/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_screenshot/settings/\
	-d allowed_hostnames="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/heatmap_screenshot/settings/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"allowed_hostnames": "array"
	}
).json()

Example response

Status 200

RESPONSE
{
  "allowed_hostnames": [
    "string"
  ],
  "cookie_delivery_enabled": true,
  "has_secret": true
}