Each API call returns either a JSON object with the requested data or a response object containing name/value pairs that indicate the status of the operation. If an error occurs, the response includes an error description.

Status Fields

  • “Success”: true — The request was valid and executed successfully.
  • “Success”: false — An error occurred.

Result Fields

  • “Result”: “OK” — The request was processed successfully.
  • “ErrorDescription”: “text error description” — A brief message describing the error.

Success Response Example

{
  "Success": true,
  "Result": "Filter 1110 has been updated"
}

Error Response Examples

{
  "Success": false,
  "ErrorDescription": [
    "Login Failed! Check your User Name or Password"
  ]
}

{ 
  "Success": false, 
  "ErrorDescription": "Invalid History ID" 
}

Dotcom-Monitor provides additional documentation explaining specific error codes. You can find detailed error descriptions in our Knowledge Base.