API Reference
  1. Convert Management API
  2. Experiences Heatmaps

Initiate heatmap live screenshot retake

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

Initiates a heatmap live screenshot retake for the given heatmap and device.
Returns the variation context, retake expiry time, and a preview URL with visa_h and visa_d query parameters.
visa_d is a numeric device code for the Visitor Insights tracking worker (0 = mobile, 1 = tablet, 2 = desktop) — deliberately not the HeatmapDevices name used by the device field.

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 device filter for the heatmap screenshot retake.

Optional filters for initiating a heatmap live screenshot retake.

string
enum
Defaults to desktop

Device type for the heatmap image.

Allowed:
Responses

Updated about 2 months ago

Did this page help you?
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 2 months ago

Did this page help you?