backlinks_domain_pages_summary

Instructions

Implementation Reference

• src/core/modules/backlinks/tools/backlinks-domain-pages-summary.tool.ts:67-80 (handler)

  The handler function that performs the core logic: makes a POST request to DataForSEO API endpoint '/v3/backlinks/domain_pages_summary/live' with formatted parameters, validates response, or formats error.

  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);
    }
  }

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

  Defines the Zod schema for input parameters: target (required), limit, offset, filters, order_by.

    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: this.getFilterExpression().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:31-64 (registration)

  Registers the tool by instantiating BacklinksDomainPagesSummaryTool in the tools array and adding it to the tools record using its getName(), wrapping getDescription(), getParams(), and handle() methods.

  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/tools/backlinks-domain-pages-summary.tool.ts:10-11 (schema)

  Returns the exact tool name 'backlinks_domain_pages_summary' used for registration.

  getName(): string {
    return 'backlinks_domain_pages_summary';