The response is in JSON format and contains the following fields:
STATUS
Contains the status of the API request and the result.
PARAMETER |
FIELD DESCRIPTION |
|
|
status
|
"message" = system message "code" = status code - see status code list below "type" = string, value can be:
Special: with Error code: "13" an additional field "httpErrorCode" is provided. See status code list below. |
|
EXAMPLES
Some examples of how a status message can look like.
### NEW URL ###
Everything works fine. The analysis is in progress. We've never seen this URL before.
RESPONSE STRUCTURE
"status": {"type":"No data yet","message":"New URL, analysis in progress", "code": 0}
### SUCCESS MESSAGE ###
Everything works fine. Analysis successful, status (code: 1)
RESPONSE STRUCTURE
"status": {"type":"OK", "message":"All seems well.","code":1}
### INCOMPLETE MESSAGE ###
Something went wrong to determining a correct category, e.g. gx_tagged, gx_retry, gx_notfound, gx_nomatches, see "categorization" status (code: 10)
RESPONSE STRUCTURE
"status": {"type":"Incomplete","message":"Categorization issues.","code":10}
### ERROR MESSAGE ###
Something went wrong. "Houston! We've got a problem."
RESPONSE STRUCTURE
Without http-error
"status": {"type":"Error","message":"Empty body","code":15}
With http-error
"status": {"type": "Error", "message": "Target URL returned non-200 HTTP Code", "code":13, "httpErrorCode": 418}
LIST OF STATUS CODES
Some examples of how a status message can look like.
### NEW AND UNKNOWN URL ###
CODE: 0
New URL, analysis in progress. We haven't seen this URL before and need to analyze it first. request the URL again or come back later to gather the result.
### OK ###
CODE: 1
Ok. All seems well. Everything works fine. Analysis successful completed.
### INCOMPLETE ###
CODE: 10
Incomplete. Something went wrong, e.g. categorization issue. We are not able to provide a full result yet. Come back later or try again.
### ERROR ###
CODE: 11
Target URL not reachable: Crawler could not create a connection to the provided URL. Usually a time-out or connection error.
CODE: 12
URL blocked by robots.txt: The website disallows crawling. This can be fixed by whitelisting the hyScore.io user-agent and/or crawler IP-addresses. More information.
CODE: 13
Target URL returned non 200 HTTP Code: Provides an additional field "httpErrorCode" with RFC standard codes, only if it's not explicitly covered by another error code (i.e 429 - too many requests), usually a 4xx/5xx error. See example section above.
CODE: 14
Unparseable body: Website body could not be decoded, usually the fault of an illegal charset.
CODE: 15
Empty body: Website was crawled successfully but has no or an empty <body>. Nothing to analyze.
CODE: 16
Unknown host: Crawler could not resolve the domain. This usually means the domain does not exist or is offline.
CODE: 17
Too many requests: Crawler was blocked by host because it sent to many requests (HTTP error code 429). This can be fixed by whitelisting the crawler. More information.
CODE: 99
Problematic URL: Technical difficulties while crawling this URL. This might be pure IP addresses with no content, ad server URLs, AWS S3 URLs or something similar.
GENERAL ERROR
"message": "Forbidden" : No OR wrong API-Key. Authentification with the API failed.
"message": "Limit exceeded" : The daily or monthly quota/limit of API requests for your API Key exceeds the configured volume. Please contact us or wait until the next month starts.
Comments
0 comments
Article is closed for comments.