backlinks_summary
Get an overview of backlinks data for any domain, subdomain, or webpage to analyze referring domains and inbound link metrics for SEO assessment.
Instructions
This endpoint will provide you with an overview of backlinks data available for a given domain, subdomain, or webpage
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| exclude_internal_backlinks | No | indicates if internal backlinks from subdomains to the target will be excluded from the results if set to true, the results will not include data on internal backlinks from subdomains of the same domain as target if set to false, internal links will be included in the results | |
| include_subdomains | No | indicates if indirect links to the target will be included in the results if 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 page if set to false, indirect links will be ignored | |
| target | Yes | domain, subdomain or webpage to get backlinks for required field a domain or a subdomain should be specified without https:// and www. a page should be specified with absolute URL (including http:// or https://) |
Input Schema (JSON Schema)
{
"properties": {
"exclude_internal_backlinks": {
"default": true,
"description": "indicates if internal backlinks from subdomains to the target will be excluded from the results\nif set to true, the results will not include data on internal backlinks from subdomains of the same domain as target\nif set to false, internal links will be included in the results",
"type": "boolean"
},
"include_subdomains": {
"default": true,
"description": "indicates if indirect links to the target will be included in the results\nif 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 page\nif set to false, indirect links will be ignored",
"type": "boolean"
},
"target": {
"description": "domain, subdomain or webpage to get backlinks for\n required field\na domain or a subdomain should be specified without https:// and www.\na page should be specified with absolute URL (including http:// or https://)",
"type": "string"
}
},
"required": [
"target"
],
"type": "object"
}