HTTP Request for Mobile Friendly tool (User Experience)
POST https://api.hexometer.com/v2/app/services/v1/detected_errors?key={YOUR_API_KEY}
Parameters
Fields
YOUR_API_KEY

string

to get YOUR_API_KEY visit hexometer select desired property then go to settings and copy your api key

Request Body
Fields
tool_name

string

you should provide the specific tool name to get the corresponding error. In this case "User_Experience_Mobile_Friendly"

property_id

number

you should provide property id

Example
{
"tool_name": "User_Experience_Mobile_Friendly",
"property_id": 25
}
Response Body

if request is successful you will get

JSON representation
{
"tool_logs": [
 UserExperienceMobileFriendly
]
}
Fields
UserExperienceMobileFriendly

object(UserExperienceMobileFriendly)

UserExperienceMobileFriendly represents a UserExperienceMobileFriendly object

Mobile Friendly (User Experience)

UserExperienceMobileFriendly object structure

JSON representation
UserExperienceMobileFriendly = {
"mobileFriendlyCheckTool": {
"error": null | Object,
"mobileFriendly": Boolean,
"mobileFriendlyIssues": Array,
"screenShootUrl": String
}
}
Fields
error

null | object

if an error exists an object is returned with error code(string) and message(string)

mobileFriendly

boolean

if website is mobile friendly

mobileFriendlyIssues

array

mobile friendly issues

screenShootUrl

string

screenshoot url

Example
{
"tool_logs": [
{
"mobileFriendlyCheckTool": {
"error": null,
"mobileFriendly": false,
"mobileFriendlyIssues": [],
"screenShootUrl": "https://storage.googleapis.com/hx-screenshots/example.com-mobile-api.png"
}
}
]
}

if request is not successful you will get

JSON representation
{
"error": true,
"message": String
}
Fields
error

boolean

if the error returns true, it means that an error has occurred

message

string

the message contains information about the error

Example
{
"error": true,
"message": "invalid API key"
}



HTTP Request for Devices Check tool (User Experience)
POST https://api.hexometer.com/v2/app/services/v1/detected_errors?key={YOUR_API_KEY}
Parameters
Fields
YOUR_API_KEY

string

to get YOUR_API_KEY visit hexometer select desired property then go to settings and copy your api key

Request Body
Fields
tool_name

string

you should provide the specific tool name to get the corresponding error. In this case "User_Experience_Devices_Check"

property_id

number

you should provide property id

Example
{
"tool_name": "User_Experience_Devices_Check",
"property_id": 25
}
Response Body

if request is successful you will get

JSON representation
{
"tool_logs": [
 UserExperienceDevicesCheck
]
}
Fields
UserExperienceDevicesCheck

object(UserExperienceDevicesCheck)

UserExperienceDevicesCheck represents a UserExperienceDevicesCheck object

User Experience Devices Check

UserExperienceDevicesCheck object structure

JSON representation
UserExperienceDevicesCheck = {
"deviceCheckTool": {
"result": {
"MOBILE_SMALL": Object,
"MOBILE_MEDIUM": Object,
"MOBILE_LARGE": Object,
"TABLET": Object,
"LAPTOP_SMALL": Object,
"LAPTOP_MEDIUM": Object,
"LAPTOP_LARGE": Object,
"DESKTOP_4K": Object
},
"error": null | String, 
"warnings": null | String
}
}
Fields
result

object

result info

MOBILE_SMALL

object

small mobile device info

MOBILE_MEDIUM

object

medium mobile device info

MOBILE_LARGE

object

large mobile device info

TABLET

object

tablet device info

LAPTOP_SMALL

object

small laptop device info

LAPTOP_MEDIUM

object

medium laptop device info

LAPTOP_LARGE

object

large laptop device info

DESKTOP_4K

object

desktop device info

error

null | string

error info

warnings

null | string

warnings info

Example
{
"tool_logs": [
{
"deviceCheckTool": {
"result": {
"MOBILE_SMALL": {
"result": {
"image": "https://storage.googleapis.com/hx-screenshots/tool-upload-checkDeviceTool-f99256bba8cfd70fbede7810d00a8f93-1225573836480.png"
"closeTouchables": {
"isValid": true,
"data": []
},
"fontSizeMean": {
"isValid": true,
"data": 16.055073874192693
},
"domElementCount": {
"isValid": true,
"data": 187
},
"cookieSize": {
"isValid": true,
"data": 456
},
"imgAlt": {
"isValid": true,
"data": [0]
},
"imgWidth": {
"isValid": false,
"data": ["<img src="img/example-logo.svg" alt="example" class="prod-logo">"]
},
"viewportWidth": {
"isValid": true,
"data": ["width=device-width"]
},
"viewport": {
"isValid": true,
"data": ["<meta content="width=device-width, initial-scale=1, maximum-scale=1" name="viewport">"]
},
"badElements": [],
"leftRightSlider": {
"isValid": true,
"data": 0
},
},
"error": null,
"warnings": null
},
},
"MOBILE_MEDIUM": {
"result": {
"image": "https://storage.googleapis.com/hx-screenshots/tool-upload-checkDeviceTool-f99256bba8cfd70fbede7810d00a8f93-1225573836480.png"
"closeTouchables": {
"isValid": true,
"data": []
},
"fontSizeMean": {
"isValid": true,
"data": 16.055073874192693
},
"domElementCount": {
"isValid": true,
"data": 187
},
"cookieSize": {
"isValid": true,
"data": 456
},
"imgAlt": {
"isValid": true,
"data": [0]
},
"imgWidth": {
"isValid": false,
"data": ["<img src="img/example-logo.svg" alt="example" class="prod-logo">"]
},
"viewportWidth": {
"isValid": true,
"data": ["width=device-width"]
},
"viewport": {
"isValid": true,
"data": ["<meta content="width=device-width, initial-scale=1, maximum-scale=1" name="viewport">"]
},
"badElements": [],
"leftRightSlider": {
"isValid": true,
"data": 0
},
},
"error": null,
"warnings": null
},
},
"MOBILE_LARGE": {
"result": {
"image": "https://storage.googleapis.com/hx-screenshots/tool-upload-checkDeviceTool-f99256bba8cfd70fbede7810d00a8f93-1225573836480.png"
"closeTouchables": {
"isValid": true,
"data": []
},
"fontSizeMean": {
"isValid": true,
"data": 16.055073874192693
},
"domElementCount": {
"isValid": true,
"data": 187
},
"cookieSize": {
"isValid": true,
"data": 456
},
"imgAlt": {
"isValid": true,
"data": [0]
},
"imgWidth": {
"isValid": false,
"data": ["<img src="img/example-logo.svg" alt="example" class="prod-logo">"]
},
"viewportWidth": {
"isValid": true,
"data": ["width=device-width"]
},
"viewport": {
"isValid": true,
"data": ["<meta content="width=device-width, initial-scale=1, maximum-scale=1" name="viewport">"]
},
"badElements": [],
"leftRightSlider": {
"isValid": true,
"data": 0
},
},
"error": null,
"warnings": null
},
},
 
"TABLET": {
"result": {
"image": "https://storage.googleapis.com/hx-screenshots/tool-upload-checkDeviceTool-f99256bba8cfd70fbede7810d00a8f93-1225573836480.png"
"closeTouchables": {
"isValid": true,
"data": []
},
"fontSizeMean": {
"isValid": true,
"data": 16.055073874192693
},
"domElementCount": {
"isValid": true,
"data": 187
},
"cookieSize": {
"isValid": true,
"data": 456
},
"imgAlt": {
"isValid": true,
"data": [0]
},
"imgWidth": {
"isValid": false,
"data": ["<img src="img/example-logo.svg" alt="example" class="prod-logo">"]
},
"viewportWidth": {
"isValid": true,
"data": ["width=device-width"]
},
"viewport": {
"isValid": true,
"data": ["<meta content="width=device-width, initial-scale=1, maximum-scale=1" name="viewport">"]
},
"badElements": [],
"leftRightSlider": {
"isValid": true,
"data": 0
},
},
"error": null,
"warnings": null
},
},
"LAPTOP_SMALL": {
"result": {
"image": "https://storage.googleapis.com/hx-screenshots/tool-upload-checkDeviceTool-f99256bba8cfd70fbede7810d00a8f93-1225573836480.png"
"closeTouchables": {
"isValid": true,
"data": []
},
"fontSizeMean": {
"isValid": true,
"data": 16.055073874192693
},
"domElementCount": {
"isValid": true,
"data": 187
},
"cookieSize": {
"isValid": true,
"data": 456
},
"imgAlt": {
"isValid": true,
"data": [0]
},
"imgWidth": {
"isValid": false,
"data": ["<img src="img/example-logo.svg" alt="example" class="prod-logo">"]
},
"viewportWidth": {
"isValid": true,
"data": ["width=device-width"]
},
"viewport": {
"isValid": true,
"data": ["<meta content="width=device-width, initial-scale=1, maximum-scale=1" name="viewport">"]
},
"badElements": [],
"leftRightSlider": {
"isValid": true,
"data": 0
},
},
"error": null,
"warnings": null
},
},
"LAPTOP_MEDIUM": {
"result": {
"image": "https://storage.googleapis.com/hx-screenshots/tool-upload-checkDeviceTool-f99256bba8cfd70fbede7810d00a8f93-1225573836480.png"
"closeTouchables": {
"isValid": true,
"data": []
},
"fontSizeMean": {
"isValid": true,
"data": 16.055073874192693
},
"domElementCount": {
"isValid": true,
"data": 187
},
"cookieSize": {
"isValid": true,
"data": 456
},
"imgAlt": {
"isValid": true,
"data": [0]
},
"imgWidth": {
"isValid": false,
"data": ["<img src="img/example-logo.svg" alt="example" class="prod-logo">"]
},
"viewportWidth": {
"isValid": true,
"data": ["width=device-width"]
},
"viewport": {
"isValid": true,
"data": ["<meta content="width=device-width, initial-scale=1, maximum-scale=1" name="viewport">"]
},
"badElements": [],
"leftRightSlider": {
"isValid": true,
"data": 0
},
},
"error": null,
"warnings": null
},
},
"LAPTOP_LARGE": {
"result": {
"image": "https://storage.googleapis.com/hx-screenshots/tool-upload-checkDeviceTool-f99256bba8cfd70fbede7810d00a8f93-1225573836480.png"
"closeTouchables": {
"isValid": true,
"data": []
},
"fontSizeMean": {
"isValid": true,
"data": 16.055073874192693
},
"domElementCount": {
"isValid": true,
"data": 187
},
"cookieSize": {
"isValid": true,
"data": 456
},
"imgAlt": {
"isValid": true,
"data": [0]
},
"imgWidth": {
"isValid": false,
"data": ["<img src="img/example-logo.svg" alt="example" class="prod-logo">"]
},
"viewportWidth": {
"isValid": true,
"data": ["width=device-width"]
},
"viewport": {
"isValid": true,
"data": ["<meta content="width=device-width, initial-scale=1, maximum-scale=1" name="viewport">"]
},
"badElements": [],
"leftRightSlider": {
"isValid": true,
"data": 0
},
},
"error": null,
"warnings": null
},
},
"DESKTOP_4K": {
"result": {
"image": "https://storage.googleapis.com/hx-screenshots/tool-upload-checkDeviceTool-f99256bba8cfd70fbede7810d00a8f93-1225573836480.png"
"closeTouchables": {
"isValid": true,
"data": []
},
"fontSizeMean": {
"isValid": true,
"data": 16.055073874192693
},
"domElementCount": {
"isValid": true,
"data": 187
},
"cookieSize": {
"isValid": true,
"data": 456
},
"imgAlt": {
"isValid": true,
"data": [0]
},
"imgWidth": {
"isValid": false,
"data": ["<img src="img/example-logo.svg" alt="example" class="prod-logo">"]
},
"viewportWidth": {
"isValid": true,
"data": ["width=device-width"]
},
"viewport": {
"isValid": true,
"data": ["<meta content="width=device-width, initial-scale=1, maximum-scale=1" name="viewport">"]
},
"badElements": [],
"leftRightSlider": {
"isValid": true,
"data": 0
},
}
"error": null,
"warnings": null
},
},
"error": null,
"warnings": null
}
}
}
]
}

if request is not successful you will get

JSON representation
{
"error": true,
"message": String
}
Fields
error

boolean

if the error returns true, it means that an error has occurred

message

string

the message contains information about the error

Example
{
"error": true,
"message": "invalid API key"
}