HTTP Request for Tech Stack tool (Health)

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 "Health_Tech_Stack"

property_id

number

you should provide property id

Example

{

"tool_name": "Health_Tech_Stack",

"property_id": 25

}

Response Body

if request is successful you will get

JSON representation

{

"tool_logs": [

HealthTechStack

]

}

Fields
HealthTechStack

object(HealthTechStack)

HealthTechStack represents a healthTechStack object

Tech Stack (Health)

HealthTechStack object structure

JSON representation

HealthTechStack = {

"techStackTool": {

"error": null | Object,

"applications": [

{

"name": String,

"confidence": Boolean,

"version": null | String,

"icon": String,

"website": String,

"categories": Array

}

],

}

}

Fields
error

null | object

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

applications

array

applications list

Example

{

"tool_logs": [

{

"techStackTool": {

"error": null,

"applications": [

{

"name": "CloudFlare",

"confidence": "100",

"version": null,

"icon": "CloudFlare.svg",

"website": "http://www.cloudflare.com",

"categories": [

"CDN"

]

}

]

}

}

]

}

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 W3C tool (Health)

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 "Health_W3C"

property_id

number

you should provide property id

Example

{

"tool_name": "Health_W3C",

"property_id": 25

}

Response Body

if request is successful you will get

JSON representation

{

"tool_logs": [

HealthW3C

]

}

Fields
HealthW3C

object(HealthW3C)

HealthW3C represents a healthW3C object

Health W3C

HealthW3C object structure

JSON representation

HealthW3C = {

"w3cCheckTool": {

"error": null | Object,

"validatorErrors": [

{

"subType": String,

"type": Boolean,

"explanation": String,

"position": Object,

"extract": String,

}

]

}

}

Fields
error

null | object

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

validatorErrors

array

validator errors list

Example

{

"tool_logs": [

{

"w3cCheckTool": {

"error": null | Object,

"validatorErrors": [

{

"subType": "",

"type": "error",

"explanation": "No 'p' element in scope but a 'p' end tag seen.",

"position": {

"lastLine": 132,

"firstColumn": 1,

"lastColumn": 4

},

"extract": "<li></ul></p></div"

}

]

}

}

]

}

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 JavaScript Errors tool (Health)

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 "Health_JavaScript_Errors"

property_id

number

you should provide property id

Example

{

"tool_name": "Health_JavaScript_Errors",

"property_id": 25

}

Response Body

if request is successful you will get

JSON representation

{

"tool_logs": [

HealthJavaScriptErrors

]

}

Fields
HealthJavaScriptErrors

object(HealthJavaScriptErrors)

HealthJavaScriptErrors represents a healthJavaScriptErrors object

JavaScript Errors (Health)

HealthJavaScriptErrors object structure

JSON representation

HealthJavaScriptErrors = {

"JsErrorsTool": {

"error": null | Object,

"allConsoleMsgs": Array

}

}

}

Fields
error

null | object

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

allConsoleMsgs

array

console messages list

Example

{

"tool_logs": [

{

"JsErrorsTool": {

"error": null,

"allConsoleMsgs": []

}

}

]

}

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 URL Checker tool (SEO)

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 "SEO_URL_Checker"

property_id

number

you should provide property id

Example

{

"tool_name": "SEO_URL_Checker",

"property_id": 25

}

Response Body

if request is successful you will get

JSON representation

{

"tool_logs": [

SEOURLChecker

]

}

Fields
SEOURLChecker

object(SEOURLChecker)

SEOURLChecker represents a SEOURLChecker object

URL Checker (SEO)

SEOURLChecker object structure

JSON representation

SEOURLChecker = {

"urlCheckerTool": {

"error": null | Object,

"favicon": Object,

"redirectUrl": String,

"canonicalUrl": Boolean,

"isHttps": Boolean,

"socialNetworks": Array,

"robotsTXT": Boolean,

"openGraphMetaTags": Array,

"twitterCardMetaTags": Array,

}

}

Fields
error

null | object

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

favicon

object

website favicon url

redirectUrl

string

redirect url

canonicalUrl

boolean

true if website has canonicalUrl

isHttps

boolean

true if website has SSL certificate

socialNetworks

array

social network url list

robotsTXT

boolean

true if website has robotsTXT file

openGraphMetaTags

array

open graph meta tags list

twitterCardMetaTags

array

twitter card meta tags list

Example

{

"tool_logs": [

{

"urlCheckerTool": {

"error": null,

"favicon": {

"favicon": "https://example.com/apple-touch-icon.png",

"hasIcon": true

},

"redirectUrl": "https://example.com/",

"canonicalUrl": true,

"isHttps": true,

"socialNetworks": [

{

"name": "instagram",

"url": "https://www.instagram.com/example/"

}

],

"robotsTXT": true,

"openGraphMetaTags": [

{

"name": "og:url",

"isExists": true,

"content": "https://www.example.com"

}

],

"twitterCardMetaTags": [

{

"name": "twitter:card",

"isExists": true,

"content": "summary_large_image"

}

],

"twitterCardMetaTags": {

"is_redirect":true,

"redirect_url": "https://www.example.com"

}

}

}

]

}

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"

}