Heatmaps

Get a page's heatmap

Attention, scroll reach, clicks and movement for one page and device over a period, from at most 20,000 of its visits (a deterministic sample when there are more), with the visit to draw it over. Fewer than 30 visits is flagged small_sample. Needs analytics.sessions.read.

get/v1/sites/{siteId}/heatmaps

Request

  • Base URL: https://api.ironfang.com/analytics
  • URL: https://api.ironfang.com/analytics/v1/sites/{siteId}/heatmaps
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Query parameters

pathstring required
Example:/pricing

The page's path, without a query string or fragment.

bucket'mobile' | 'tablet' | 'desktop' required

By viewport width when the visit began, under 768, under 1280, and wider.

fromstring date-time

The period's start; with to, at most 93 days. Both left out is the seven days to now.

tostring date-time

The period's end, not included.

Response

Heatmap

bucket'mobile' | 'tablet' | 'desktop' required

By viewport width when the visit began, under 768, under 1280, and wider.

fromstring date-time required
pathstring required
sampledinteger required

The visits the totals come from, at most 20000.

small_sampleboolean required

Fewer than 30 visits.

tostring date-time required
visibility_knownnumber required

The share of visits whose time excludes a hidden tab (SDK 0.5.0).

visitsinteger required

Page visits in the period.

Changes

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