API reference / Analytics
Get the clicks of a page
Where visitors click on one page, from the session replays of the period. x is in thousandths of the width of the page, y in pixels from its top, each rounded to 10. latest is the newest replay that viewed the page: its page is the picture under the clicks.
/api/v1/analytics/heatmapOther ways to call it
troopy analytics heatmaptroopy_get_analytics_heatmapQuery parameters
periodenum<string>now is the last 10 minutes. 7d and 30d end today. 3m, 6m and 12m are whole months that end with this month. week starts on Monday. custom needs from and to
nowtodayyesterday24h7d30d3m6m12mweekmonthyearallcustom
Default "30d"
fromstringYYYY-MM-DD, in the workspace's time zone
date
tostringYYYY-MM-DD. The period includes this day
date
page*stringA path, such as /pricing
At least 1 characters · At most 500 characters
screenenum<string>The clicks of phones (a window under 768 pixels) or of wider screens. Without it, the one with more clicks
mobiledesktop
Response
200 · application/jsondata*object6 properties
page*stringscreen*enum<string>mobiledesktop
replays*integerlatest*string | nullclicks*integerpoints*array<object>3 properties
x*integery*integern*integer