Brand Studio normalized DataForSEO search-volume result

Source: schemas/dataforseo-search-volume-result.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-search-volume-result.schema.json",
  "title": "Brand Studio normalized DataForSEO search-volume result",
  "description": "The credential-safe search-volume value returned by the Brand Studio DataForSEO adapter. Missing provider measurements remain null or absent, never fabricated zeroes.",
  "oneOf": [
    {
      "type": "object",
      "required": [
        "status",
        "provider",
        "requested",
        "results",
        "cost"
      ],
      "properties": {
        "status": {
          "const": "passed"
        },
        "provider": {
          "const": "dataforseo"
        },
        "requested": {
          "type": "integer",
          "minimum": 1,
          "maximum": 1000
        },
        "cost": {
          "type": "number",
          "minimum": 0
        },
        "results": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "keyword",
              "search_volume",
              "competition",
              "competition_index",
              "cpc"
            ],
            "properties": {
              "keyword": {
                "type": "string",
                "minLength": 1,
                "maxLength": 80
              },
              "search_volume": {
                "type": [
                  "number",
                  "null"
                ],
                "minimum": 0
              },
              "competition": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "competition_index": {
                "type": [
                  "number",
                  "null"
                ],
                "minimum": 0
              },
              "cpc": {
                "type": [
                  "number",
                  "null"
                ],
                "minimum": 0
              }
            },
            "additionalProperties": false
          }
        }
      },
      "additionalProperties": false
    },
    {
      "type": "object",
      "required": [
        "status",
        "reason",
        "requested",
        "results"
      ],
      "properties": {
        "status": {
          "enum": [
            "disabled",
            "failed",
            "blocked",
            "budget_exhausted"
          ]
        },
        "reason": {
          "type": "string",
          "minLength": 1
        },
        "requested": {
          "type": "integer",
          "minimum": 0,
          "maximum": 1000
        },
        "results": {
          "type": "array",
          "maxItems": 0
        }
      },
      "additionalProperties": false
    }
  ]
}