HeatmapsFilter values that exist for one page

Filter values that exist for one page

Devices, sources and mediums with the session count behind each — what a filter UI should be built from.

Scoped to sessions that have points ON that page, not to the location's traffic. A dropdown offering desktop when no desktop visitor ever reached the page produces an empty heatmap and reads as a bug, so every value returned here yields at least one row.

Fetch these unfiltered. If the facets themselves are filtered, narrowing one dimension empties the others and leaves no way back.

curl -X GET "https://mythic-analytics.gulp.workers.dev/client/v1/data/heatmap/facets?location_id=example_string&url=acme.com%2Fpricing&date_from=2024-12-25T10%3A00%3A00Z&date_to=2024-12-25T10%3A00%3A00Z" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": {
    "page": "acme.com/pricing",
    "device_type": [
      {
        "value": "mobile",
        "sessions": 412
      }
    ],
    "utm_source": [
      {
        "value": "mobile",
        "sessions": 412
      }
    ],
    "utm_medium": [
      {
        "value": "mobile",
        "sessions": 412
      }
    ]
  }
}
GET
/client/v1/data/heatmap/facets
GET
Base URLstring

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

Bearer Token
Bearer Tokenstring
Required

Agency key (ak_) or location secret key (sk_). Scoped keys (mcp_) are accepted too and need heatmaps:read. See Using an mcp_ key over HTTP.

Agency key (ak_) or location secret key (sk_). Scoped keys (mcp_) are accepted too and need heatmaps:read. See Using an mcp_ key over HTTP.
query
location_idstring

Required with an agency key (ak_); ignored with a location key (sk_). Can also be sent as the X-Location-Id header.

query
date_fromstring
Format: date-time
query
date_tostring
Format: date-time
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Agency key (ak_) or location secret key (sk_). Scoped keys (mcp_) are accepted too and need heatmaps:read. See Using an mcp_ key over HTTP.

Query Parameters

location_idstring

Required with an agency key (ak_); ignored with a location key (sk_). Can also be sent as the X-Location-Id header.

urlstring
Required
Example:
acme.com/pricing

Responses

successboolean
dataobject