backlinks_domain_pages_summary
Analyze backlink profiles for domains or specific pages to identify referring domains, anchor text, and link metrics for SEO assessment.
Instructions
This endpoint will provide you with detailed summary data on all backlinks and related metrics for each page of the target domain or subdomain you specify. If you indicate a single page as a target, you will get comprehensive summary data on all backlinks for that page
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| 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://) | |
| limit | No | the maximum number of returned anchors | |
| offset | No | offset in the results array of returned anchors optional field default value: 0 if you specify the 10 value, the first ten anchors in the results array will be omitted and the data will be provided for the successive anchors | |
| filters | No | array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ["referring_links_types.anchors",">","1"] [["broken_pages",">","2"], "and", ["backlinks",">","10"]] [["first_seen",">","2017-10-23 11:31:45 +00:00"], "and", [["anchor","like","%seo%"],"or",["referring_domains",">","10"]]] | |
| order_by | No | results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting type example: ["backlinks,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["backlinks,desc","rank,asc"] |
Implementation Reference
- The handler function that implements the core logic of the tool by sending a POST request to the DataForSEO API endpoint '/v3/backlinks/domain_pages_summary/live' with formatted parameters and handling the response.
async handle(params: any): Promise<any> { try { const response = await this.client.makeRequest('/v3/backlinks/domain_pages_summary/live', 'POST', [{ target: params.target, limit: params.limit, offset: params.offset, filters: this.formatFilters(params.filters), order_by: this.formatOrderBy(params.order_by), }]); return this.validateAndFormatResponse(response); } catch (error) { return this.formatErrorResponse(error); } } - Defines the input schema using Zod, specifying parameters such as target (required), limit, offset, filters, and order_by with detailed descriptions and constraints.
getParams(): z.ZodRawShape { return { target: z.string().describe(`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://)`), limit: z.number().min(1).max(1000).default(10).optional().describe("the maximum number of returned anchors"), offset: z.number().min(0).optional().describe( `offset in the results array of returned anchors optional field default value: 0 if you specify the 10 value, the first ten anchors in the results array will be omitted and the data will be provided for the successive anchors` ), filters: z.array( z.union([ z.array(z.union([z.string(), z.number(), z.boolean()])).length(3), z.enum(["and", "or"]) ]) ).max(8).optional().describe( `array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, =, <>, in, not_in, like, not_like, ilike, not_ilike, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ["referring_links_types.anchors",">","1"] [["broken_pages",">","2"], "and", ["backlinks",">","10"]] [["first_seen",">","2017-10-23 11:31:45 +00:00"], "and", [["anchor","like","%seo%"],"or",["referring_domains",">","10"]]]` ), order_by: z.array(z.string()).optional().describe( `results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting type example: ["backlinks,desc"] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ["backlinks,desc","rank,asc"]` ), }; } - src/core/modules/backlinks/backlinks-api.module.ts:41-41 (registration)Registers the tool by instantiating BacklinksDomainPagesSummaryTool in the getTools() method's tools array, which is used to expose the tool with its name, description, params, and handler.
new BacklinksDomainPagesSummaryTool(this.dataForSEOClient), - src/core/modules/backlinks/backlinks-api.module.ts:14-14 (registration)Imports the BacklinksDomainPagesSummaryTool class necessary for its registration in the module.
import { BacklinksDomainPagesSummaryTool } from './tools/backlinks-domain-pages-summary.tool.js'; - Defines the tool's name as 'backlinks_domain_pages_summary', which is used for registration and invocation.
getName(): string { return 'backlinks_domain_pages_summary';