heatmap_capture

get/api/projects/{project_id}/heatmap_capture/settings/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/heatmap_capture/settings/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Response

capture_mode'all' | 'url_allowlist' required
  • all - All URLs
  • url_allowlist - Only listed URLs
url_allowliststring[] required

Full http(s) URLs that may send heatmap data. Use * to match any characters.

enforcement_enabledboolean required

Whether this installation enforces the URL allow-list for heatmap capture.

can_capture_all_urlsboolean required

Whether this organization's plan may capture heatmaps on every page.

capture_url_limitinteger nullable required

How many URLs this plan may capture, or null when the plan captures all pages.

Changes

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