Backlinks Live

{
  "$defs": {
    "BacklinksBacklinksLiveRequestInfo": {
      "properties": {
        "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 for your target;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"
            }
          ]
        },
        "custom_mode": {
          "anyOf": [
            {
              "additionalProperties": {
                "anyOf": [
                  {
                    "type": "object"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "description": "detailed results grouping typeoptional fielduse this object to get a specific number of backlinks per fieldif you use custom_mode, then mode will be ignoredexample:\"custom_mode\": {\"field\": \"domain\", \"value\": 100}",
              "type": "object"
            },
            {
              "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:=, <>, in, not_in, like, not_like, ilike, not_ilike, regex, not_regex, match, not_matchyou can use the % operator with like and not_like to match any string of zero or more charactersexample:[\"rank\",\">\",\"80\"][[\"page_from_rank\",\">\",\"55\"],\"and\",[\"dofollow\",\"=\",true]][[\"first_seen\",",
              "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"
            }
          ]
        },
        "limit": {
          "anyOf": [
            {
              "description": "the maximum number of returned backlinksoptional fielddefault value: 100maximum value: 1000",
              "type": "integer"
            },
            {
              "type": "null"
            }
          ]
        },
        "mode": {
          "anyOf": [
            {
              "description": "results grouping typeoptional fieldpossible grouping types:as_is - returns all backlinksone_per_domain - returns one backlink per domainone_per_anchor - returns one backlink per anchordefault value: as_is",
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "offset": {
          "anyOf": [
            {
              "description": "offset in the results array of the returned backlinksoptional fielddefault value: 0if you specify the 10 value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks;Note: the maximum value is 20,000, use the search_after_token if you would like to offset more results",
              "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:[\"domain_from_rank,desc\",\"page_from_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"
            }
          ]
        },
        "search_after_token": {
          "anyOf": [
            {
              "description": "token for subsequent requestsoptional fieldprovided in the identical filed of the response to each request;use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request;by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task;search_after_token values are unique for each subsequent task ;Note: if the search_after_token is specified in the request, all other parameters should be identic",
              "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 backlinks 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/BacklinksBacklinksLiveRequestInfo"
              }
            ],
            "type": "object"
          },
          {
            "type": "null"
          }
        ]
      },
      "type": "array"
    }
  },
  "required": [],
  "type": "object"
}