# Domain Rank Overview **API:** Data API **Endpoint:** `POST /v1/beta/dataforseo/dataforseo_labs/google/domain_rank_overview/live` **Tags:** DataForSEO A domain's search footprint: organic and paid keyword counts, estimated traffic and traffic value, by `location_code`. Returns `se_type`, `target`, `total_count`, `items_count` and `items`. Wrapped in DataForSEO's envelope: data in `tasks[0].result`, outcome in `tasks[0].status_code` - a rejected request still returns HTTP 200. For the same numbers over time use `post_dataforseo_labs_google_historical_rank_live`; for many domains at once, `post_dataforseo_labs_google_bulk_traffic_estimation_live`. ### Pricing reference - Metering: Reported response cost. - Reference request estimate: USD 0.0121. - Reference customer multiplier: 1.0. Do not apply it again to a settled customer amount. Reference metadata only, not an account quote, a guaranteed price or a spending cap. Resource credits are not Felo credits. Final charges follow Felo billing records. ## Base URL - `https://openapi.felo.ai` ## Authentication - `FeloBearerAuth` (http bearer, bearer format Felo API Key) - `FeloApiKey` (apiKey in header `X-API-Key`) ## Request body Required: **no** ### application/json Schema: ```json { "type": "array", "items": { "type": [ "object", "null" ], "oneOf": [ { "type": "object", "properties": { "target": { "type": "string", "description": "domain
required field
the domain name of the target website
the domain should be specified without https:// and www." }, "location_name": { "type": [ "string", "null" ], "description": "full name of the location
optional field
if you use this field, you don't need to specify location_code
you can receive the list of available locations with their location_name by making a separate request to the
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:
United Kingdom" }, "location_code": { "type": [ "integer", "null" ], "description": "location code
optional field
if you use this field, you don't need to specify location_name
you can receive the list of available locations with their location_code by making a separate request to the
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available locations
example:
2840" }, "language_name": { "type": [ "string", "null" ], "description": "full name of the language
optional field
if you use this field, you don't need to specify language_code
you can receive the list of available languages with their language_name by making a separate request to the
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:
English" }, "language_code": { "type": [ "string", "null" ], "description": "language code
optional field
if you use this field, you don't need to specify language_name
you can receive the list of available languages with their language_code by making a separate request to the
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
ignore this field to get the results for all available languages
example:
en" }, "ignore_synonyms": { "type": [ "boolean", "null" ], "description": "ignore highly similar keywords
optional field
if set to_true, all highly similar keywords will be excluded from the ranking and traffic calculations, the results will be based on data for main keywords from groups of synonyms
default value: falsen" }, "limit": { "type": [ "integer", "null" ], "description": "the maximum number of returned results for domain
optional field
default value: 100
maximum value: 1000" }, "offset": { "type": [ "integer", "null" ], "description": "offset in the results array of returned items
optional field
default value: 0
if you specify the 10 value, the first ten items in the results array will be omitted and the data will be provided for the successive items" }, "tag": { "type": [ "string", "null" ], "description": "user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response" } }, "example": [ { "target": "dataforseo.com", "language_name": "English", "location_code": 2840 } ] } ] }, "example": [ { "target": "dataforseo.com", "language_name": "English", "location_code": 2840 } ] } ``` ## Responses ### 200 — Successful operation Headers: - `X-Request-Id` (string) — Request identifier to include when contacting Felo support. **application/json** Schema: object | null ```json { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveResponseInfo" } ] } ``` ### 400 — The request could not be processed. Check the request parameters. ### 401 — A valid Felo API key is required. ### 402 — The request cannot proceed because a billing requirement is not met. ### 403 — The account is not permitted to perform this operation. ### 429 — A request or spending limit has been reached. ### 502 — The service could not complete the request. ### 503 — The API or billing service is temporarily unavailable. ### 504 — The service timed out while processing the request. ### default — Error response; upstream passthrough responses may use provider formats **application/json** Schema: ```json {} ``` ## Schema definitions ### Response36Afe1097B20_BaseResponseInfo `#/components/schemas/Response36Afe1097B20_BaseResponseInfo` ```json { "properties": { "version": { "type": [ "string", "null" ], "description": "the current version of the API" }, "status_code": { "type": [ "integer", "null" ], "description": "general status code\nyou can find the full list of the response codes here" }, "status_message": { "type": [ "string", "null" ], "description": "general informational message\nyou can find the full list of general informational messages here" }, "time": { "type": [ "string", "null" ], "description": "total execution time, seconds" }, "cost": { "type": [ "number", "null" ], "description": "total tasks cost, USD", "format": "double" }, "tasks_count": { "type": [ "integer", "null" ], "description": "the number of tasks in the tasks array", "format": "int64" }, "tasks_error": { "type": [ "integer", "null" ], "description": "the number of tasks in the tasks array returned with an error", "format": "int64" } } } ``` ### Response36Afe1097B20_BaseResponseTaskInfo `#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo` ```json { "properties": { "id": { "type": [ "string", "null" ], "description": "task identifier\nunique task identifier in our system in the UUID format" }, "status_code": { "type": [ "integer", "null" ], "description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here" }, "status_message": { "type": [ "string", "null" ], "description": "informational message of the task\nyou can find the full list of general informational messages here" }, "time": { "type": [ "string", "null" ], "description": "execution time, seconds" }, "cost": { "type": [ "number", "null" ], "description": "total tasks cost, USD", "format": "double" }, "result_count": { "type": [ "integer", "null" ], "description": "number of elements in the result array", "format": "int64" }, "path": { "type": [ "array", "null" ], "items": { "type": [ "string", "null" ] }, "description": "URL path" }, "data": { "type": [ "object", "null" ], "additionalProperties": { "type": [ "object", "null" ] }, "description": "contains the same parameters that you specified in the POST request" } } } ``` ### Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveItem `#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveItem` ```json { "type": "object", "properties": { "se_type": { "type": [ "string", "null" ], "description": "search engine type" }, "location_code": { "type": [ "integer", "null" ], "description": "location code in a POST array" }, "language_code": { "type": [ "string", "null" ], "description": "language code in a POST array" }, "metrics": { "type": [ "object", "null" ], "additionalProperties": { "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsMetricsInfo" }, "description": "ranking data relevant to the specified domain" } } } ``` ### Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveResponseInfo `#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveResponseInfo` ```json { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo" }, { "type": "object", "properties": { "tasks": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveTaskInfo" } ] }, "description": "array of tasks" } } } ] } ``` ### Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveResultInfo `#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveResultInfo` ```json { "type": "object", "properties": { "se_type": { "type": [ "string", "null" ], "description": "search engine type" }, "target": { "type": [ "string", "null" ], "description": "target domain in a POST array" }, "location_code": { "type": [ "integer", "null" ], "description": "location code in a POST array" }, "language_code": { "type": [ "string", "null" ], "description": "language code in a POST array" }, "total_count": { "type": [ "integer", "null" ], "description": "total amount of results in our database relevant to your request", "format": "int64" }, "items_count": { "type": [ "integer", "null" ], "description": "the number of results returned in the items array", "format": "int64" }, "items": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveItem" } ] }, "description": "contains ranking and traffic data" } } } ``` ### Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveTaskInfo `#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveTaskInfo` ```json { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo" }, { "type": "object", "properties": { "result": { "type": [ "array", "null" ], "items": { "type": [ "object", "null" ], "oneOf": [ { "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleDomainRankOverviewLiveResultInfo" } ] }, "description": "array of results" } } } ] } ``` ### Response36Afe1097B20_DataforseoLabsMetricsInfo `#/components/schemas/Response36Afe1097B20_DataforseoLabsMetricsInfo` ```json { "type": "object", "properties": { "pos_1": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain or subdomain ranks #1" }, "pos_2_3": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain or subdomain ranks #2-3" }, "pos_4_10": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain or subdomain ranks #4-10" }, "pos_11_20": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain or subdomain ranks #11-20" }, "pos_21_30": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain or subdomain ranks #21-30" }, "pos_31_40": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain or subdomain ranks #31-40" }, "pos_41_50": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain or subdomain ranks #41-50" }, "pos_51_60": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain or subdomain ranks #51-60" }, "pos_61_70": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain or subdomain ranks #61-70" }, "pos_71_80": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain or subdomain ranks #71-80" }, "pos_81_90": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain or subdomain ranks #81-90" }, "pos_91_100": { "type": [ "integer", "null" ], "description": "number of organic SERPs where the domain or subdomain ranks #91-100" }, "etv": { "type": [ "number", "null" ], "description": "estimated traffic volume
estimated organic monthly traffic to the domain or subdomain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain or subdomain ranks for
learn more about how the metric is calculated in this help center article" }, "count": { "type": [ "integer", "null" ], "description": "total count of organic SERPs that contain the domain or subdomain", "format": "int64" }, "estimated_paid_traffic_cost": { "type": [ "number", "null" ], "description": "estimated cost of converting organic search traffic into paid
represents the estimated monthly cost (USD) of running ads for all keywords in the category that the domain or subdomain ranks for
the metric is calculated as the product of organic etv and paid cpc values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search
learn more about how the metric is calculated in this help center article" }, "is_new": { "type": [ "integer", "null" ], "description": "number of new ranked elements
indicates how many new ranked elements were found for the indicated target" }, "is_up": { "type": [ "integer", "null" ], "description": "rank went up
indicates how many ranked elements of the indicated target went up" }, "is_down": { "type": [ "integer", "null" ], "description": "rank went down
indicates how many ranked elements of the indicated target went down" }, "is_lost": { "type": [ "integer", "null" ], "description": "lost ranked elements
indicates how many ranked elements of the indicated target were previously presented in SERPs, but weren't found during the last check" }, "clickstream_etv": { "type": [ "number", "null" ], "description": "estimated traffic volume based on clickstream data
calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article", "format": "double" }, "clickstream_gender_distribution": { "type": [ "object", "null" ], "additionalProperties": { "type": [ "integer", "null" ], "format": "int64" }, "description": "distribution of estimated clickstream-based metrics by gender
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article" }, "clickstream_age_distribution": { "type": [ "object", "null" ], "additionalProperties": { "type": [ "integer", "null" ], "format": "int64" }, "description": "distribution of clickstream-based metrics by age
to retrieve results for this field, the parameter include_clickstream_data must be set to true
learn more about how the metric is calculated in this help center article" } } } ```