backlinks_bulk_pages_summary
Analyze backlinks for up to 1000 pages, domains, or subdomains to get comprehensive SEO insights and link profile summaries.
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 |
|---|---|---|---|
| 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. | |
| 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 |
Implementation Reference
- The core handler function that executes the tool logic by sending a POST request to the DataForSEO API endpoint '/v3/backlinks/bulk_pages_summary/live' with the provided targets and include_subdomains parameters.
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 Zod schema for the tool's input parameters: targets (required array of strings) and optional include_subdomains (boolean, default true).
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) }; } - src/core/modules/backlinks/backlinks-api.module.ts:49-49 (registration)Instantiates and registers the BacklinksBulkPagesSummaryTool in the getTools() method of the BacklinksApiModule, making it available via its getName() 'backlinks_bulk_pages_summary'.
new BacklinksBulkPagesSummaryTool(this.dataForSEOClient), - Defines the tool name as 'backlinks_bulk_pages_summary', used for registration in the module.
getName(): string { return 'backlinks_bulk_pages_summary'; }