Google Competitors Domain Live

{
  "$defs": {
    "DataforseoLabsGoogleCompetitorsDomainLiveRequestInfo": {
      "properties": {
        "exclude_domains": {
          "anyOf": [
            {
              "description": "exclude domains from the resultsoptional fielduse this parameter to exclude specific domains from the resultsNote: you can specify up to 1000 domains in this arrayexample:\"exclude_domains\": [\"reddit.com\",\"youtube.com\"]",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "exclude_top_domains": {
          "anyOf": [
            {
              "description": "indicates whether to exclude world's largest websitesoptional fielddefault value: falseset to true if you want to get highly-relevant competitors excluding the websites listed below:wikipedia.orgpinterest.comamazon.comgoogle.comfacebook.comwordpress.commedium.comquora.comreddit.comyoutube.comebay.comuol.com.brinstagram.comolx.comtwitter.comlinkedin.comslideshare.net",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "filters": {
          "anyOf": [
            {
              "description": "array of results filtering parametersoptional fieldyou can add several filters at once (8 filters maximum)you should set a logical operator and, or between the conditionsthe following operators are supported:regex, not_regex, <, <=, >, >=, =, <>, in, not_inexample:[\"metrics.organic.count\",\">\",50][[[\"metrics.organic.count\",\">=\",50],\"and\",[\"metrics.organic.pos_1\",\"in\",[1,5]]],\"or\",[\"metrics.organic.etv\",\">=\",\"100\"]]for more information about filters, please refer to Data",
              "items": {
                "anyOf": [
                  {
                    "type": "object"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "ignore_synonyms": {
          "anyOf": [
            {
              "description": "ignore highly similar keywordsoptional fieldif set to_true, only core keywords will be returned, all highly similar keywords will be excluded; default value: falsen",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "include_clickstream_data": {
          "anyOf": [
            {
              "description": "include or exclude data from clickstream-based metrics in the resultoptional fieldif the parameter is set to_true, you will receive clickstream_etv, clickstream_gender_distribution, and_clickstream_age_distribution_fields with clickstream data in the responsedefault value: falsewith this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center articlen",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "intersecting_domains": {
          "anyOf": [
            {
              "description": "additional domains for improving results accuracyoptional fieldto improve the accuracy of the result, you can specify domains that are known to intersect with the target in SERPs;if you use this array, metrics in the result will be based on SERPs where both target website and intersecting_domains appear;Note: you can specify up to 20 domains in this array",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "item_types": {
          "anyOf": [
            {
              "description": "display results by item typeoptional fieldindicates the type of search results included in the responseNote: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array; you will not be able to sort and filter results by the types of search results not included in the response;possible values: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]default value: [\"organic\", \"paid\"]",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "language_code": {
          "anyOf": [
            {
              "description": "language coderequired field if you don't specify language_nameNote: it is required to specify either language_name or language_codeyou can receive the list of available languages with their language_code by making a separate request to the",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "language_name": {
          "description": "full name of the languagerequired field if you don't specify language_codeNote: it is required to specify either language_name or language_codeyou can receive the list of available languages with their language_name by making a separate request to the",
          "type": "string"
        },
        "limit": {
          "anyOf": [
            {
              "description": "the maximum number of returned domainsoptional fielddefault value: 100maximum value: 1000",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "location_code": {
          "description": "location coderequired field if you don't specify location_nameNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with their location_code by making a separate request to the",
          "type": "integer"
        },
        "location_name": {
          "description": "full name of the locationrequired field if you don't specify location_codeNote: it is required to specify either location_name or location_codeyou can receive the list of available locations with their location_name by making a separate request to the Kingdom",
          "type": "string"
        },
        "max_rank_group": {
          "anyOf": [
            {
              "description": "maximum rank up to which competitors will be consideredoptional fielddefault value: 100if you specify 10 here, we will extract competitors from the top 10 Google search results only",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "offset": {
          "anyOf": [
            {
              "description": "offset in the results array of returned domainsoptional fielddefault value: 0if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "order_by": {
          "anyOf": [
            {
              "description": "results sorting rulesoptional fieldyou can use the same values as in the filters array to sort the resultspossible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending orderyou should use a comma to specify a sorting typeexample:[\"metrics.paid.etv,asc\"]Note: you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:[\"metrics.organic.etv,desc\",\"metrics.paid.count,asc\"]",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "tag": {
          "anyOf": [
            {
              "description": "user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "target": {
          "description": "domainrequired fieldthe domain name of the target websitethe domain should be specified without and www.you can specify page URL, but the results will be specific to the domain in the specified URL",
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "body": {
      "items": {
        "anyOf": [
          {
            "oneOf": [
              {
                "$ref": "#/$defs/DataforseoLabsGoogleCompetitorsDomainLiveRequestInfo"
              }
            ],
            "type": "object"
          },
          {
            "type": "null"
          }
        ]
      },
      "type": "array"
    }
  },
  "required": [],
  "type": "object"
}