backlinks_referring_networks
Analyze referring networks and domains linking to any website or page to identify backlink sources and assess link-building opportunities for SEO strategy.
Instructions
This endpoint will provide you with a detailed overview of referring domains pointing to the target you specify
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filters | No | 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_pages",">","1"] [["referring_pages",">","2"], "and", ["backlinks",">","10"]] [["first_seen",">","2017-10-23 11:31:45 +00:00"], "and", [["network_address","like","194.1.%"],"or",["referring_ips",">","10"]]] | |
| limit | No | the maximum number of returned networks | |
| network_address_type | No | indicates the type of network to get data for optional field possible values: ip, subnet default value: ip | ip |
| offset | No | offset in the results array of returned networks optional field default value: 0 if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages | |
| order_by | No | 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"] | |
| target | Yes | 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://) |
Implementation Reference
- The handler function that performs the core logic: formats parameters and makes a POST request to the DataForSEO Backlinks Referring Networks live endpoint.async handle(params: any): Promise<any> { try { const response = await this.client.makeRequest('/v3/backlinks/referring_networks/live', 'POST', [{ target: params.target, limit: params.limit, offset: params.offset, filters: this.formatFilters(params.filters), order_by: this.formatOrderBy(params.order_by), network_address_type: params.network_address_type }]); return this.validateAndFormatResponse(response); } catch (error) { return this.formatErrorResponse(error); } }
- Input schema defined using Zod, specifying parameters like target (required), limit, offset, filters, order_by, and network_address_type.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://)`), network_address_type: z.string().optional().default('ip').describe(`indicates the type of network to get data for optional field possible values: ip, subnet default value: ip`), limit: z.number().min(1).max(1000).default(10).optional().describe("the maximum number of returned networks"), offset: z.number().min(0).optional().describe( `offset in the results array of returned networks optional field default value: 0 if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages` ), 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_pages",">","1"] [["referring_pages",">","2"], "and", ["backlinks",">","10"]] [["first_seen",">","2017-10-23 11:31:45 +00:00"], "and", [["network_address","like","194.1.%"],"or",["referring_ips",">","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"]` ), }; }
- Tool name definition used for registration.getName(): string { return 'backlinks_referring_networks'; }
- src/core/modules/backlinks/backlinks-api.module.ts:47-47 (registration)Instantiation of the BacklinksReferringNetworksTool within the BacklinksApiModule's getTools() method for registration into the tool registry.new BacklinksReferringNetworksTool(this.dataForSEOClient),
- Mapping of tool name to API filter path 'referring_networks' used in the filters tool.'backlinks_referring_networks': 'referring_networks',