backlinks_bulk_pages_summary
Analyze comprehensive backlink data for up to 1000 pages, domains, or subdomains to understand link profiles and identify linking opportunities.
Instructions
This endpoint will provide you with a comprehensive overview of backlinks and related data for a bulk of up to 1000 pages, domains, or subdomains. 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 |
|---|---|---|---|
| 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 | |
| targets | Yes | domains, subdomains or webpages to get summary data 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://) you can specify up to 1000 pages, domains, or subdomains in each request. note that the URLs you set in a single request cannot belong to more than 100 different domains. |
Implementation Reference
- The main handler function that executes the tool logic by sending a POST request to the DataForSEO backlinks bulk pages summary endpoint and handling the response.
async handle(params: any): Promise<any> { try { const response = await this.client.makeRequest('/v3/backlinks/bulk_pages_summary/live', 'POST', [{ targets: params.targets, include_subdomains: params.include_subdomains, }]); return this.validateAndFormatResponse(response); } catch (error) { return this.formatErrorResponse(error); } } - Defines the input schema using Zod for the tool parameters: targets (required array of strings) and include_subdomains (optional boolean).
getParams(): z.ZodRawShape { return { targets: z.array(z.string()).describe(`domains, subdomains or webpages to get summary data 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://) you can specify up to 1000 pages, domains, or subdomains in each request. note that the URLs you set in a single request cannot belong to more than 100 different domains.`), include_subdomains: z.boolean().optional().describe(`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`).default(true) }; } - Defines the unique name of the tool used for registration.
getName(): string { return 'backlinks_bulk_pages_summary'; } - src/core/modules/backlinks/backlinks-api.module.ts:51-51 (registration)Instantiates the BacklinksBulkPagesSummaryTool instance within the tools array.
new BacklinksBulkPagesSummaryTool(this.dataForSEOClient), - src/core/modules/backlinks/backlinks-api.module.ts:56-63 (registration)Registers all tools, including backlinks_bulk_pages_summary, by mapping their name to definition with bound handler.
return tools.reduce((acc, tool) => ({ ...acc, [tool.getName()]: { description: tool.getDescription(), params: tool.getParams(), handler: (params: any) => tool.handle(params), }, }), {});