API Reference

Get heatmap overlay (interaction) image

post
https://api.convert.com/api/v2/accounts//projects//experiences//heatmaps//overlay

Retrieves the overlay image for a specific heatmap, device, and interaction type.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

ID of the account that owns the retrieved/saved data

integer
required

ID of the project to be retrieved

integer
required

ID of the experience

string
required

ID of the heatmap.

Body Params

Optional filters for the heatmap overlay image (e.g. device, interaction type). Passed in body for extensibility.

Optional filters for the heatmap overlay (interaction) image.

string
enum
Defaults to desktop

Device type for the heatmap image.

Allowed:
string
enum
Defaults to click

Interaction type for the heatmap overlay.

Allowed:
Responses

Updated about 12 hours ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 12 hours ago