POST https://api.hexometer.com/v2/app/services/v1/detected_errors?key={YOUR_API_KEY}
Fields | |
---|---|
YOUR_API_KEY | string to get YOUR_API_KEY visit hexometer select desired property then go to settings and copy your api key |
Fields | |
---|---|
tool_name | string you should provide the specific tool name to get the corresponding error. In this case "Performance_Assets" |
property_id | number you should provide property id |
{
"tool_name": "Performance_Assets",
"property_id": 25
}
if request is successful you will get
{
"tool_logs": [
PerformanceAssets
]
}
Fields | |
---|---|
PerformanceAssets | object(PerformanceAssets) PerformanceAssets represents a PerformanceAssets object |
PerformanceAssets object structure
PerformanceAssets = {
"assetsCheckerTool": {
"error": null | Object,
"assets": Array,
"totalSize": Number,
"mainHtmlSize": Number
}
}
Fields | |
---|---|
error | null | object if an error exists an object is returned with error code(string) and message(string) |
assets | array asset array |
totalSize | number total size |
mainHtmlSize | number main Html size |
{
"tool_logs": [
{
"assetsCheckerTool": {
"error": null,
"assets": [
{
"encodedSize": 12332,
"size": 12332,
"mimeType": "application/javascript",
"url": "https://ajax.cloudflare.com/cdn-cgi/scripts/7d5fb10a/cloudflare-static/example.min.js"
}
],
"totalSize": 2187601,
"mainHtmlSize": 25235
}
}
]
}
if request is not successful you will get
{
"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 |
{
"error": true,
"message": "invalid API key"
}
POST https://api.hexometer.com/v2/app/services/v1/detected_errors?key={YOUR_API_KEY}
Fields | |
---|---|
YOUR_API_KEY | string to get YOUR_API_KEY visit hexometer select desired property then go to settings and copy your api key |
Fields | |
---|---|
tool_name | string you should provide the specific tool name to get the corresponding error. In this case "Performance_Page_Speed_Desktop" |
property_id | number you should provide property id |
{
"tool_name": "Performance_Page_Speed_Desktop",
"property_id": 25
}
if request is successful you will get
{
"tool_logs": [
PerformancePageSpeedDesktop
]
}
Fields | |
---|---|
PerformancePageSpeedDesktop | object(PerformancePageSpeedDesktop) PerformancePageSpeedDesktop represents a PerformancePageSpeedDesktop object |
PerformancePageSpeedDesktop object structure
PerformancePageSpeedDesktop = {
"webMetricsDesktopTool": {
"error": null | Object,
"result": {
"performance": Object,
"accessibility": Object,
"bestPractices": Object,
"pwa": Object,
"seo": Object,
"assets": Object (JSON)
}
}
}
Fields | |
---|---|
error | null | object if an error exists an object is returned with error code(string) and message(string) |
performance | object performance info |
accessibility | object accessibility info |
bestPractices | object best practices info |
seo | object SEO info |
assets | object assets info |
{
"tool_logs": [
{
"webMetricsDesktopTool": {
"error": null,
"result": {
"performance": {
"title": "Performance",
"auditRefs": [
"id": "first-contentful-paint",
"weight": 15,
"group": "metrics"
]
},
"accessibility": {
"title": "Accessibility",
"description": "These checks highlight opportunities to [improve the accessibility of your web app](https://developers.google.com/web/fundamentals/accessibility). Only a subset of accessibility issues can be automatically detected so manual testing is also encouraged.",
"manualDescription": "These items address areas which an automated testing tool cannot cover. Learn more in our guide on [conducting an accessibility review](https://developers.google.com/web/fundamentals/accessibility/how-to-review).",
"auditRefs": [
"id": "accesskeys",
"weight": 0,
"group": "a11y-navigation"
]
},
"bestPractices": {
"title": "Best Practices",
"auditRefs": [
"id": "is-on-https",
"weight": 1,
"group": "best-practices-trust-safety"
]
},
"pwa": {
"title": "Progressive Web App",
"description": "These checks validate the aspects of a Progressive Web App. [Learn more](https://developers.google.com/web/progressive-web-apps/checklist).",
"manualDescription": "These checks are required by the baseline [PWA Checklist](https://developers.google.com/web/progressive-web-apps/checklist) but are not automatically checked by Lighthouse. They do not affect your score but it's important that you verify them manually.",
"auditRefs": [
"id": "nstallable-manifest",
"weight": 2,
"group": "pwa-installable"
]
},
"seo": {
"title": "SEO",
"description": "These checks ensure that your page is optimized for search engine results ranking. There are additional factors Lighthouse does not check that may affect your search ranking. [Learn more](https://support.google.com/webmasters/answer/35769).",
"manualDescription": "Run these additional validators on your site to check additional SEO best practices.",
"auditRefs": [
"id": "viewport",
"weight": 1,
"group": "seo-mobile"
]
},
"assets":"{"total_size":2554807,"size_by_domain":{"example.com":2290254,"fonts.googleapis.com":6180,"ajax.cloudflare.com":12332,"fonts.gstatic.com":39344,"www.googletagmanager.com":206697}"
},
}
}
]
}
if request is not successful you will get
{
"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 |
{
"error": true,
"message": "invalid API key"
}
POST https://api.hexometer.com/v2/app/services/v1/detected_errors?key={YOUR_API_KEY}
Fields | |
---|---|
YOUR_API_KEY | string to get YOUR_API_KEY visit hexometer select desired property then go to settings and copy your api key |
Fields | |
---|---|
tool_name | string you should provide the specific tool name to get the corresponding error. In this case "Performance_Page_Speed_Mobile" |
property_id | number you should provide property id |
{
"tool_name": "Performance_Page_Speed_Mobile",
"property_id": 25
}
if request is successful you will get
{
"tool_logs": [
PerformancePageSpeedMobile
]
}
Fields | |
---|---|
PerformancePageSpeedMobile | object(PerformancePageSpeedMobile) PerformancePageSpeedMobile represents a PerformancePageSpeedMobile object |
PerformancePageSpeedMobile object structure
PerformancePageSpeedMobile = {
"webMetricsMobileTool": {
"error": null | Object,
"result": {
"performance": Object,
"accessibility": Object,
"bestPractices": Object,
"pwa": Object,
"seo": Object,
"assets": Object (JSON)
}
}
}
Fields | |
---|---|
error | null | object if an error exists an object is returned with error code(string) and message(string) |
performance | object performance info |
accessibility | object accessibiliy info |
bestPractices | object best practices info |
seo | object SEO info |
assets | object assets info |
{
"tool_logs": [
{
"webMetricsMobileTool": {
"error": null,
"result": {
"performance": {
"title": "Performance",
"auditRefs": [
"id": "first-contentful-paint",
"weight": 15,
"group": "metrics"
]
},
"accessibility": {
"title": "Accessibility",
"description": "These checks highlight opportunities to [improve the accessibility of your web app](https://developers.google.com/web/fundamentals/accessibility). Only a subset of accessibility issues can be automatically detected so manual testing is also encouraged.",
"manualDescription": "These items address areas which an automated testing tool cannot cover. Learn more in our guide on [conducting an accessibility review](https://developers.google.com/web/fundamentals/accessibility/how-to-review).",
"auditRefs": [
"id": "accesskeys",
"weight": 0,
"group": "a11y-navigation"
]
},
"bestPractices": {
"title": "Best Practices"",
"auditRefs": [
"id": "is-on-https",
"weight": 1,
"group": "best-practices-trust-safety"
]
},
"pwa": {
"title": "Progressive Web App",
"description": "These checks validate the aspects of a Progressive Web App. [Learn more](https://developers.google.com/web/progressive-web-apps/checklist).",
"manualDescription": "These checks are required by the baseline [PWA Checklist](https://developers.google.com/web/progressive-web-apps/checklist) but are not automatically checked by Lighthouse. They do not affect your score but it's important that you verify them manually.",
"auditRefs": [
"id": "nstallable-manifest",
"weight": 2,
"group": "pwa-installable"
]
},
"seo": {
"title": "SEO",
"description": "These checks ensure that your page is optimized for search engine results ranking. There are additional factors Lighthouse does not check that may affect your search ranking. [Learn more](https://support.google.com/webmasters/answer/35769).",
"manualDescription": "Run these additional validators on your site to check additional SEO best practices.",
"auditRefs": [
"id": "viewport",
"weight": 1,
"group": "seo-mobile"
]
},
"assets":"{"total_size":2554807,"size_by_domain":{"example.com":2290254,"fonts.googleapis.com":6180,"ajax.cloudflare.com":12332,"fonts.gstatic.com":39344,"www.googletagmanager.com":206697}"
},
}
}
]
}
if request is not successful you will get
{
"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 |
{
"error": true,
"message": "invalid API key"
}