DataForSEO consumed API response envelope

Source: schemas/dataforseo-api-response-envelope.schema.json. This is the complete declaration, including nested definitions and constraints. Its presence is not evidence that a runtime producer or consumer validates against it.

All schemas · Data structures and lineage

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://mirrorfactory.com/schemas/dataforseo-api-response-envelope.schema.json",
  "title": "DataForSEO consumed API response envelope",
  "description": "The subset of the upstream DataForSEO response envelope Brand Studio relies on before endpoint-specific normalization. Unknown upstream fields are retained as compatible additions.",
  "type": "object",
  "required": [
    "status_code",
    "status_message",
    "cost",
    "tasks"
  ],
  "properties": {
    "version": {
      "type": "string"
    },
    "status_code": {
      "type": "integer"
    },
    "status_message": {
      "type": "string"
    },
    "time": {
      "type": "string"
    },
    "cost": {
      "type": "number",
      "minimum": 0
    },
    "tasks_count": {
      "type": "integer",
      "minimum": 0
    },
    "tasks_error": {
      "type": "integer",
      "minimum": 0
    },
    "tasks": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "status_code",
              "cost",
              "result"
            ],
            "properties": {
              "id": {
                "type": "string"
              },
              "status_code": {
                "type": "integer"
              },
              "status_message": {
                "type": "string"
              },
              "time": {
                "type": "string"
              },
              "cost": {
                "type": "number",
                "minimum": 0
              },
              "result_count": {
                "type": "integer",
                "minimum": 0
              },
              "path": {
                "type": "array"
              },
              "data": {
                "type": "object"
              },
              "result": {
                "type": [
                  "array",
                  "object",
                  "null"
                ]
              }
            },
            "additionalProperties": true
          }
        }
      ]
    }
  },
  "allOf": [
    {
      "if": {
        "properties": {
          "status_code": {
            "const": 20000
          }
        },
        "required": [
          "status_code"
        ]
      },
      "then": {
        "properties": {
          "tasks": {
            "type": "array",
            "minItems": 1
          }
        }
      }
    }
  ],
  "additionalProperties": true
}