Domain Pages Live

{
  "$defs": {
    "BacklinksDomainPagesLiveRequestInfo": {
      "properties": {
        "backlinks_filters": {
          "anyOf": [
            {
              "description": "filter the backlinks of your targetoptional fieldyou can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your targetyou can filter the backlinks by all fields available in the response of this endpointusing this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics forexample:\"backlinks_filters\": [\"dofollow\", \"=\", true]",
              "items": {
                "anyOf": [
                  {
                    "type": "object"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "backlinks_status_type": {
          "anyOf": [
            {
              "description": "set what backlinks to return and countoptional fieldyou can use this field to choose what backlinks will be returned and used for aggregated metrics;possible values: all - all backlinks will be returned and counted;live - backlinks found during the last check will be returned and counted;lost - lost backlinks will be returned and counted;default value: live",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "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"
            }
          ]
        },
        "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:[\"meta.internal_links_count\",\">\",\"1\"][[\"meta.external_links_count\",\">\",\"2\"],\"and\",[\"backl",
              "items": {
                "anyOf": [
                  {
                    "type": "object"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "type": "array"
            },
            {
              "type": "null"
            }
          ]
        },
        "include_subdomains": {
          "anyOf": [
            {
              "description": "indicates if the subdomains of the target will be included in the searchoptional fieldif set to false, the subdomains will be ignoreddefault value: true",
              "type": "boolean"
            },
            {
              "type": "null"
            }
          ]
        },
        "internal_list_limit": {
          "anyOf": [
            {
              "description": "maximum number of elements within internal arraysoptional fieldyou can use this field to limit the number of elements within the following arrays:referring_links_tldreferring_links_typesreferring_links_attributesreferring_links_platform_typesreferring_links_semantic_locationsdefault value: 10maximum value: 1000",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "limit": {
          "anyOf": [
            {
              "description": "the maximum number of returned pagesoptional fielddefault value: 100maximum value: 1000",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "offset": {
          "anyOf": [
            {
              "description": "offset in the results array of returned pagesoptional fielddefault value: 0if you specify the 10 value, the first ten pages 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:[\"page_summary.backlinks,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:[\"page_summary.backlinks,desc\",\"page_summar",
              "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 or subdomainrequired fielda domain or a subdomain should be specified without and www.example:forbes.com",
          "type": "string"
        }
      },
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "body": {
      "items": {
        "anyOf": [
          {
            "oneOf": [
              {
                "$ref": "#/$defs/BacklinksDomainPagesLiveRequestInfo"
              }
            ],
            "type": "object"
          },
          {
            "type": "null"
          }
        ]
      },
      "type": "array"
    }
  },
  "required": [],
  "type": "object"
}