Heatmaps API Reference

Heatmaps

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

Endpoints

`GET`
`GET`
`GET`
`GET`

List all environments heatmaps

Required API key scopes

heatmap:read

Path parameters

environment_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "results": [
        {
          "count": 0,
          "pointer_y": 0,
          "pointer_relative_x": 0.1,
          "pointer_target_fixed": true
        }
      ]
    }
  ]
}

Retrieve environments heatmaps events

Required API key scopes

heatmap:read

Path parameters

environment_id
string

Example request

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

Example response

Status 200 No response body

List all heatmaps

Required API key scopes

heatmap:read

Path parameters

project_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

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

Example response

Status 200

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "results": [
        {
          "count": 0,
          "pointer_y": 0,
          "pointer_relative_x": 0.1,
          "pointer_target_fixed": true
        }
      ]
    }
  ]
}

Retrieve heatmaps events

Required API key scopes

heatmap:read

Path parameters

project_id
string

Example request

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

Heatmaps

Endpoints

List all environments heatmaps

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Retrieve environments heatmaps events

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

List all heatmaps

Required API key scopes

Path parameters

Query parameters

Response

Example request

Example response

Status 200

Retrieve heatmaps events

Required API key scopes

Path parameters

Example request

Example response

Status 200 No response body

Community questions