Competitors Live

{
  "$defs": {
    "BacklinksCompetitorsLiveRequestInfo": {
      "properties": {
        "exclude_internal_backlinks": {
          "anyOf": [
            {
              "description": "indicates if internal backlinks from subdomains to the target will be excluded from the resultsoptional fieldif set to true, the results will not include data on internal backlinks from subdomains of the same domain as targetif set to false, internal links will be included in the resultsdefault value: true",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "exclude_large_domains": {
          "anyOf": [
            {
              "description": "indicates whether large domain will appear in resultsoptional fieldif set to true, the results from the large domain (google.com, amazon.com, etc.) will be omitted;default value: true",
              "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_in, like, not_like, ilike, not_ilike, match, not_matchyou can use the % operator with like and not_like to match any string of zero or more charactersexample:[\"rank\",\">\",\"100\"][[\"target\",\"like\",\"%forbes%\"],\"and\",[[\"rank\",\">\",\"100\"],\"or\",[\"intersec",
              "items": {
                "anyOf": [
                  {
                    "type": "object"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "limit": {
          "anyOf": [
            {
              "description": "the maximum number of returned domainsoptional fielddefault value: 100maximum value: 1000",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "main_domain": {
          "anyOf": [
            {
              "description": "indicates if only main domain of the target will be included in the searchoptional fieldif set to true, only the main domain will be included in search;default value: true",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "offset": {
          "anyOf": [
            {
              "description": "offset in the results array of returned domainsoptional fielddefault value: 0if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages",
              "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 set up a sorting typeexample:[\"rank,desc\"]note that you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:[\"intersections,desc\",\"rank,asc\"]",
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "rank_scale": {
          "anyOf": [
            {
              "description": "defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank valuesoptional fieldyou can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scalepossible values:one_hundred — rank values are displayed on a 0–100 scaleone_thousand — rank values are displayed on a 0–1000 scaledefault value: one_thousandlearn more about how this parameter works and how ranking metrics are calculated in this Help Center article",
              "type": "string"
            },
            {
              "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": "domain, subdomain or webpage to get competitor domains forrequired fielda domain or a subdomain should be specified without and www.a page should be specified with absolute URL (including or",
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "body": {
      "items": {
        "anyOf": [
          {
            "oneOf": [
              {
                "$ref": "#/$defs/BacklinksCompetitorsLiveRequestInfo"
              }
            ],
            "type": "object"
          },
          {
            "type": "null"
          }
        ]
      },
      "type": "array"
    }
  },
  "required": [],
  "type": "object"
}