Trigger screenshot generation for experience variations

post

https://api.convert.com/api/v2/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/trigger-screenshots

Initiates the process of generating or regenerating screenshots for the variations of a specified experience. These screenshots are displayed in the Convert UI to help visualize the changes made in each variation. The Knowledge Base article "Whitelist IPs for Screenshot Previews" is related as it lists IPs our service uses.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

project_id

integer

required

ID of the project to which save/retrieved data is connected

experience_id

integer

required

ID of the Experience

Body Params

Parameters for triggering screenshot generation for an experience's variations.

variations

array of numbers

An optional list of specific variation IDs for which to generate/regenerate screenshots. If omitted, screenshots are triggered for all variations within the experience.

variations

force_regenerate

boolean

If set to true, screenshots are triggered for all variations within the experience, regardless of whether they have a manual screenshot uploaded. If omitted, screenshots are triggered only for variations that do not have a manual screenshot uploaded.

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A generic success response, typically used for operations that don't return specific data (like deletions or some updates). The code is usually 200, and message confirms the successful action.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.