SettingsGet the heatmap-capture override

Get the heatmap-capture override

Return the location's heatmap-capture override plus whether capture is effectively on. Readable with an agency key (ak_, pass ?location_id=) or a viewer key (sk_).

Unlike autocapture, null here means off: heatmap capture is opt-in per location, so an unconfigured location captures nothing.

curl -X GET "https://mythic-analytics.gulp.workers.dev/client/v1/settings/heatmaps" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": {
    "capture_heatmaps": true,
    "effective": {
      "enabled": true
    }
  }
}
GET
/heatmaps
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Builder/client key as a bearer token. Agency key for read-write (Bearer ak_...) or viewer key for read-only (Bearer sk_...). Scoped keys (mcp_) are accepted too and need settings:read or settings:write. See Using an mcp_ key over HTTP.

Builder/client key as a bearer token. Agency key for read-write (Bearer ak_...) or viewer key for read-only (Bearer sk_...). Scoped keys (mcp_) are accepted too and need settings:read or settings:write. See Using an mcp_ key over HTTP.
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Builder/client key as a bearer token. Agency key for read-write (Bearer ak_...) or viewer key for read-only (Bearer sk_...). Scoped keys (mcp_) are accepted too and need settings:read or settings:write. See Using an mcp_ key over HTTP.

Responses

successboolean
dataobject