backlinks_domain_intersection

Instructions

Implementation Reference

• src/core/modules/backlinks/tools/backlinks-domain-intersection.tool.ts:69-82 (handler)

  The handle method implements the tool's core logic, making a POST request to DataForSEO's domain_intersection endpoint with processed parameters and handling response or error.

  async handle(params: any): Promise<any> {
    try {
      const response = await this.client.makeRequest('/v3/backlinks/domain_intersection/live', 'POST', [{
        targets: mapArrayToNumberedKeys(params.targets),
        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-intersection.tool.ts:19-67 (schema)

  Defines the Zod schema for the tool's input parameters: targets (required array of strings), limit, offset, filters, and order_by.

    getParams(): z.ZodRawShape {
      return {
        targets: z.array(z.string()).describe(`domains, subdomains or webpages to get links for
  required field
  you can set up to 20 domains, subdomains or webpages
  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 results"),
        offset: z.number().min(0).optional().describe(
          `offset in the array of returned results
  optional field
  default value: 0
  if you specify the 10 value, the first ten backlinks in the results array will be omitted and the data will be provided for the successive backlinks`
        ),
        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:
  ["1.internal_links_count",">","1"]
  [["2.referring_pages",">","2"],
  "and",
  ["1.backlinks",">","10"]]
  
  [["1.first_seen",">","2017-10-23 11:31:45 +00:00"],
  "and",
  [["2.target","like","%dataforseo.com%"],"or",["1.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 backlinks_domain_intersection tool (line 42: new BacklinksDomainIntersectionTool) among others by creating instances and reducing them into a tool definition record with name, description, params, and handler wrapper.

  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-filters.tool.ts:22-33 (helper)

  Static map in BacklinksFiltersTool that associates 'backlinks_domain_intersection' with filter path 'domain_intersection' for filter handling.

  private static readonly TOOL_TO_FILTER_MAP: { [key: string]: string } = {
    'backlinks_content_duplicates': 'content_duplicates',
    'backlinks_backlinks': 'backlinks',
    'backlinks_domain_pages': 'domain_pages',
    'backlinks_anchors': 'anchors',
    'backlinks_referring_domains': 'referring_domains',
    'backlinks_domain_intersection': 'domain_intersection',
    'backlinks_page_intersection': 'page_intersection',
    'backlinks_referring_networks': 'referring_networks',
    'backlinks_domain_pages_summary': 'domain_pages_summary',
    'backlinks_competitors': 'competitors'
  };

• src/core/modules/backlinks/tools/backlinks-domain-intersection.tool.ts:11-13 (schema)

  Returns the canonical tool name 'backlinks_domain_intersection' used for registration.

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