domain_analytics_whois_overview
Retrieve Whois data enriched with backlink statistics, ranking information, and traffic metrics from organic and paid search results for specified domains.
Instructions
This endpoint will provide you with Whois data enriched with backlink stats, and ranking and traffic info from organic and paid search results. Using this endpoint you will be able to get all these data for the domains matching the parameters you specify in the request
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | the maximum number of returned domains | |
| offset | No | offset in the results array of returned businesses optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities | |
| 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, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ["rating.value",">",3] | |
| 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 parameter example: ["rating.value,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: ["rating.value,desc","rating.votes_count,desc"] | |
| is_claimed | No | indicates whether the business is verified by its owner on Google Maps |
Implementation Reference
- The main handler function that executes the tool logic: formats parameters, makes POST request to DataForSEO API endpoint '/v3/domain_analytics/whois/overview/live', validates and formats response or error.
async handle(params: any): Promise<any> { try { const response = await this.client.makeRequest('/v3/domain_analytics/whois/overview/live', 'POST', [{ 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); } } - Input schema validation using Zod for tool parameters: limit, offset, filters, order_by, is_claimed.
getParams(): z.ZodRawShape { return { limit: z.number().min(1).max(1000).default(10).optional().describe("the maximum number of returned domains"), offset: z.number().min(0).optional().describe( `offset in the results array of returned businesses optional field default value: 0 if you specify the 10 value, the first ten entities in the results array will be omitted and the data will be provided for the successive entities` ), filters: z.array( z.union([ z.array(z.union([z.string(), z.number(), z.boolean()])).length(3), z.enum(["and", "or"]) ]) ).max(8).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, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ["rating.value",">",3]` ), 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 parameter example: ["rating.value,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: ["rating.value,desc","rating.votes_count,desc"]` ), is_claimed: z.boolean().optional().describe(`indicates whether the business is verified by its owner on Google Maps`).default(true) }; } - Tool registration in DomainAnalyticsApiModule's getTools() method: instantiates WhoisOverviewTool and registers it with name, description, params, and handler reference.
getTools(): Record<string, ToolDefinition> { const tools = [ new WhoisOverviewTool(this.dataForSEOClient), new WhoisFiltersTool(this.dataForSEOClient), new DomainTechnologiesTool(this.dataForSEOClient), new DomainTechnologiesFiltersTool(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), }, }), {}); } - Helper mapping in WhoisFiltersTool that associates the tool name with its filter path 'overview' for filter handling.
private static readonly TOOL_TO_FILTER_MAP: { [key: string]: string } = { 'domain_analytics_whois_overview': 'overview' };