dataforseo_labs_google_domain_rank_overview
Analyze domain ranking distribution and estimated monthly traffic from organic and paid search results for SEO performance evaluation.
Instructions
This endpoint will provide you with ranking and traffic data from organic and paid search for the specified domain. You will be able to review the domain ranking distribution in SERPs as well as estimated monthly traffic volume for both organic and paid results.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| target | Yes | target domain | |
| location_name | No | full name of the location required field only in format "Country" (not "City" or "Region") example: 'United Kingdom', 'United States', 'Canada' | United States |
| language_code | No | language code required field example: en | en |
| ignore_synonyms | No | ignore highly similar keywords, if set to true, results will be more accurate |
Implementation Reference
- The handler function that executes the core tool logic by making a POST request to the DataForSEO Labs API endpoint '/v3/dataforseo_labs/google/domain_rank_overview/live' using the provided input parameters.
async handle(params: any): Promise<any> { try { const response = await this.client.makeRequest('/v3/dataforseo_labs/google/domain_rank_overview/live', 'POST', [{ target: params.target, location_name: params.location_name, language_code: params.language_code, ignore_synonyms: params.ignore_synonyms }]); return this.validateAndFormatResponse(response); } catch (error) { return this.formatErrorResponse(error); } } - Zod schema defining the input parameters: target (domain), location_name, language_code, ignore_synonyms.
getParams(): z.ZodRawShape { return { target: z.string().describe(`target domain`), location_name: z.string().default("United States").describe(`full name of the location required field in format "Country" example: United Kingdom`), language_code: z.string().default("en").describe( `language code required field example: en`), ignore_synonyms: z.boolean().default(true).describe( `ignore highly similar keywords, if set to true, results will be more accurate`) }; } - Instantiation and registration of the GoogleDomainRankOverviewTool in the DataForSEOLabsApi module's getTools() method, which returns a record of all tools including this one mapped by name.
new GoogleDomainRankOverviewTool(this.dataForSEOClient),