#4 : Result and Response

The response is in JSON format and contains the following fields:

RESPONSE (DEFAULT)

Contains the status of the API request and the result.

PARAMETER	FIELD	FIELD DESCRIPTION
status	message code type	"message" = system message "code" = status code - see status code list below "type" = string, value can be: "No data yet": URL is not known yet by hyScore "Ok": request was successful, all seems well "Error": an error occurred, see status code "Incomplete": the analysis result is not complete yet, try again or come back later. Please take a look at chapter #4.1 Status messages and codes for more information.
result	brandrisk	"risk":  "0" = False ; means no risk / critical content "1" = True ; means critical content "weight":  If the value is greater than > 45, a text is potentially critical and is output by the analysis as "risk": "1" in the result. Below the threshold value < 45, the risk is displayed with "risk": "0".  Example   "brandRisk": {             "risk": 0,             "weight": 1.7831457301367146
	customData	An additional custom field. The parameter and value appear if the customData input field is used in the POST. Any format allowed (numeric, strings), e.g. “23D-XZ-2300” or “[e-mail]”. Note: this information is just looped through the system. We don't store or cache this information. Example "customData": "xyz01234"
Advice: Additional output in hyScore|analyze In order to simplify integration into an existing AdTech connection and to avoid any development effort on the part of the customer, the BrandRisk indicator can be integrated as a special IAB category in the results output of the IAB categories in hyScore|analyze. Example of an IAB category. Can be configured in consultation with hyScore as follows: "v2": 9999 "v2-parent": 9999 !!! If the IAB category with ID 9999 appears in the IAB category edition, the BrandRisk indicator is "risk" (see above): 1 (True). Example "categories": {             "hyscore": [                 { … result of hyScore categories                 }             ],             "iab": [                 {                     "category": "BrandRisk",                     "v2": 9999,                     "v2-parent": 9999,                     "weight": 9999                 }             ]         },