backlinks_summary

Instructions

Implementation Reference

• src/core/modules/backlinks/tools/backlinks-summary.tool.ts:33-44 (handler)

  The main handler function that implements the core logic of the 'backlinks_summary' tool by making an API request to DataForSEO's backlinks summary endpoint.

  async handle(params: any): Promise<any> {
    try {
      const response = await this.client.makeRequest('/v3/backlinks/summary/live', 'POST', [{
        target: params.target,
        include_subdomains: params.include_subdomains,
        exclude_internal_backlinks: params.exclude_internal_backlinks
      }]);
      return this.validateAndFormatResponse(response);
    } catch (error) {
      return this.formatErrorResponse(error);
    }
  }

• src/core/modules/backlinks/tools/backlinks-summary.tool.ts:18-31 (schema)

  Zod schema defining the input parameters for the 'backlinks_summary' tool, including target, include_subdomains, and exclude_internal_backlinks.

    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://)`),
        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),
        exclude_internal_backlinks: z.boolean().optional().describe(`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`).default(true)
      };
    }

• src/core/modules/backlinks/backlinks-api.module.ts:31-64 (registration)

  Registration of the BacklinksSummaryTool instance within the getTools() method of BacklinksApiModule, mapping it to the 'backlinks_summary' name with its schema and handler.

  getTools(): Record<string, ToolDefinition> {
    const tools = [
      new BacklinksTool(this.dataForSEOClient),
      new BacklinksAnchorTool(this.dataForSEOClient),
      new BacklinksBulkBacklinksTool(this.dataForSEOClient),
      new BacklinksBulkNewLostReferringDomainsTool(this.dataForSEOClient),
      new BacklinksBulkNewLostBacklinksTool(this.dataForSEOClient),
      new BacklinksBulkRanksTool(this.dataForSEOClient),
      new BacklinksBulkReferringDomainsTool(this.dataForSEOClient),
      new BacklinksBulkSpamScoreTool(this.dataForSEOClient),
      new BacklinksCompetitorsTool(this.dataForSEOClient),
      new BacklinksDomainIntersectionTool(this.dataForSEOClient),
      new BacklinksDomainPagesSummaryTool(this.dataForSEOClient),
      new BacklinksDomainPagesTool(this.dataForSEOClient),
      new BacklinksPageIntersectionTool(this.dataForSEOClient),
      new BacklinksReferringDomainsTool(this.dataForSEOClient),
      new BacklinksReferringNetworksTool(this.dataForSEOClient),
      new BacklinksSummaryTool(this.dataForSEOClient),
      new BacklinksTimeseriesNewLostSummaryTool(this.dataForSEOClient),
      new BacklinksTimeseriesSummaryTool(this.dataForSEOClient),
      new BacklinksBulkPagesSummaryTool(this.dataForSEOClient),
      new BacklinksFiltersTool(this.dataForSEOClient)
      // Add more tools here
    ];
  
    return tools.reduce((acc, tool) => ({
      ...acc,
      [tool.getName()]: {
        description: tool.getDescription(),
        params: tool.getParams(),
        handler: (params: any) => tool.handle(params),
      },
    }), {});
  }

• src/core/modules/backlinks/backlinks-api.module.ts:22-22 (registration)

  Import statement for the BacklinksSummaryTool class.

  import { BacklinksSummaryTool } from './tools/backlinks-summary.tool.js';

• src/core/modules/backlinks/tools/backlinks-summary.tool.ts:10-12 (handler)

  The getName() method that defines the tool's name as 'backlinks_summary'.

  getName(): string {
    return 'backlinks_summary';
  }