Search Response Schema

for SCREENSHOT the response returns a base64 image.

for WEB SCRAPE it's the entire page's html as a string.

{
   "$schema": "http://json-schema.org/schema#",
   "type": "object",
   "properties": {
      "criteria": {
         "type": "string"
      },
      "type": {
         "type": "string"
      },
      "status": {
         "type": "string"
      },
      "sources": {
         "type": "array",
         "items": {
            "type": "object",
            "properties": {
               "name": {
                  "type": "string"
               }
            },
            "required": [
               "name"
            ]
         }
      },
      "data": {
         "type": "array",
         "items": {
            "type": "object",
            "properties": {
               "web_collection": {
                  "type": "string"
               }
            },
            "required": [
               "web_collection"
            ]
         }
      }
   },
   "required": [
      "criteria",
      "data",
      "sources",
      "status",
      "type"
   ]
}

Last updated