Summary Live

{
  "$defs": {
    "BacklinksSummaryLiveRequestInfo": {
      "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 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"
            }
          ]
        },
        "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"
            }
          ]
        },
        "include_indirect_links": {
          "anyOf": [
            {
              "description": "indicates if indirect links to the target will be included in the resultsoptional fieldif set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical pageif set to false, indirect links will be ignoreddefault value: true",
              "type": "boolean"
            },
            {
              "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"
            }
          ]
        },
        "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 data 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/BacklinksSummaryLiveRequestInfo"
              }
            ],
            "type": "object"
          },
          {
            "type": "null"
          }
        ]
      },
      "type": "array"
    }
  },
  "required": [],
  "type": "object"
}