Heatmaps

Compare two periods

One page and device over two periods, with the targets clicked in both and how their rate changed. overlay_valid says both periods have the same most common layout, so a difference overlay on one page means something; across a redesign, show them side by side. Needs analytics.sessions.read.

get/v1/sites/{siteId}/heatmaps/compare

Request

  • Base URL: https://api.ironfang.com/analytics
  • URL: https://api.ironfang.com/analytics/v1/sites/{siteId}/heatmaps/compare
  • 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.

a_fromstring date-time required
a_tostring date-time required
b_fromstring date-time required
b_tostring date-time required

Response

Comparison

overlay_validboolean required

Changes

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