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

How to aggregate counts: 'total_count' (every interaction, default) or 'unique_visitors' (distinct people).

• unique_visitors - unique_visitors
• total_count - total_count

JSON array of cohort IDs (e.g. '[123, 456]') to restrict results to people in those cohorts. Feature-flagged; ignored when the cohort filter is not enabled for the caller.

Start of the window. Relative (e.g. '-7d', '-30d', '-1mStart') or an absolute 'YYYY-MM-DD' date. Defaults to '-7d'. Heatmap data is retained for 90 days.

End of the window, inclusive. Relative or absolute 'YYYY-MM-DD'. Defaults to today.

JSON array of event filters (e.g. '[{"id": "purchase", "properties": []}]') to restrict results to sessions in which those events occurred. Each entry needs a string 'id' (the event name) and may carry a 'properties' array of property filters applied to that event, each of type 'event' or 'element'. Several entries are combined with AND: the session must contain a matching event for every entry. At most 10 entries, each with at most 20 property filters. Requires project-wide heatmap access, since the filter reads the project's events rather than one saved heatmap. Feature-flagged; ignored when the event filter is not enabled for the caller.

When true, exclude sessions from internal/test accounts using the project's test-account filters.

When true (default), drop interactions recorded at the (0, 0) origin, which are usually noise.

Maximum interactions to return (1-100).

Number of interactions to skip, for pagination.

JSON array of the heatmap coordinates to drill into, e.g. '[{"x": 0.5, "y": 100}]'. Each point needs 'x' (relative x, 0..1) and 'y' (absolute client-y pixels) matching values returned by the heatmaps list endpoint; an optional 'target_fixed' boolean matches fixed-position elements. Returns the individual session interactions behind those spots.

Inclusive UTC instant. Supply with timestamp_to to override date bounds.

Exclusive UTC instant. Supply with timestamp_from to override date bounds.

The interaction type to return. One of: 'click' (default), 'rageclick', 'mousemove', or 'scrolldepth'. Scrolldepth returns scroll buckets instead of x/y coordinates.

Match a single page by exact URL (trailing slash is ignored). Mutually exclusive with url_pattern.

Match pages by regex against the full current_url (anchored automatically). Use this to aggregate across query strings or path segments. Mutually exclusive with url_exact.

Only include interactions captured at a viewport at most this wide, in CSS pixels.

Only include interactions captured at a viewport at least this wide, in CSS pixels. Use with viewport_width_max to isolate a device class (e.g. 360-768 for mobile).