Screenshot capture API documentation

This page provides API documentation for Screenshot capture

To make a request for Screenshot capture result use this POST API.

HTTP Request
POST https://api.hexomatic.com/tool-api/screenshot-capture?key={YOUR_API_KEY}
Parameters
Fields
YOUR_API_KEY

string

to get YOUR_API_KEY visit hexomatic settings API/Webhook section and copy your key

Request Body
Fields
source

string

you should provide a source URL

devices

string[]

you should provide array of devices

delay

number (optional)

The amount of time the tool waits before the screenshot capture. The default value is 5s.

Available values: 5, 10, 15, 30.

adBlock

boolean (optional)

If provided true the tool will block ads before capturing. The default value is false.

height

number (optional)

If not specified the tool will take a full screenshot. The height should be given in px.

Example
{
"source": "https://example.com",
"devices": ["MOBILE_SMALL", "MOBILE_MEDIUM", "MOBILE_LARGE", "TABLET", "LAPTOP_SMALL","LAPTOP_MEDIUM", "LAPTOP_LARGE","DESKTOP_4K"],
"delay": 5,
"adBlock": true,
"height": 1000
}
Response Body

if request is successful you will get

JSON representation
{
"taskId": "13f4b463-7e8a-429a-b62b-4afde618a154"
}

if request is not successful you will get

JSON representation
{
"statusCode": 403,
"message": "Forbidden"
}

To get the result for Screenshot capture use this GET API.

HTTP Request
GET https://api.hexomatic.com/tool-api/result/{TASK_ID}?key={YOUR_API_KEY}
Parameters
Fields
YOUR_API_KEY

string

to get YOUR_API_KEY visit hexomatic settingsand API/Webhook section and copy your key

TASK_ID

string

if you did Screenshot capture POST request you must have received taskId that is valid one month after making the POST request. You can try to make this GET request with apx 5 minutes frequency after making the POST request for the tool.

Response Body

if request is successful you will get

JSON representation
{
"result": {
 "_device_screenshot_tablet": [
"https://storage.googleapis.com/hexomatic-screenshot/screenshot-device-53b1e84f660ad853aef58ba761d97dfe-1644392413132.png"
 ]
}
}

if request is not successful you will get

JSON representation
{
"statusCode": 403,
"message": "Forbidden"
}