DataForSEO
SEO, search-engine results, keyword research, backlinks and AI visibility data.
Ranked Keywords
The Amazon search terms a product ranks for. Pages with limit, offset and offset_token; use the token past the first pages. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. This is Labs' own Amazon index, so it pages and answers immediately - unlike seo-merchant, which queues a live scrape of the store.
- 型: array object[]
- 型: object
- asin型: string必須
product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint
- filters型: array
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: ["keyword_data.keyword_info.search_volume","in",[100,1000]]; for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide
- ignore型: boolean
_synonyms ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false
- language型: string
_code language code required field if don’t 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 example: en
- language型: string
_name full name of the language required field if don’t 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 example: English
- limit型: integer
the maximum number of products in the results array optional field default value: 100; maximum value: 1000
- location型: integer
_code location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840
- location型: string
_name full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States
- offset型: integer
offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords
- order型: array string[]
_by 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: ["keyword_data.keyword_info.competition,desc"] default rule: ["ranked_serp_element.serp_item.rank_group,asc"] 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: ["keyword_data.keyword_info.search_volume,desc","keyword_data.keyword_info.cpc,desc"]
- tag型: string
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
空のオブジェクト空のオブジェクト
- 型: object200
Successful response
- 型: numbercost
total tasks cost, USD
- 型: integerstatus
_code general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
- 型: stringstatus
_message general informational message you can find the full list of general informational messages here
- 型: array string[]tasks
array of tasks
- 型: integertasks
_count the number of tasks in the tasks array
- 型: integertasks
_error the number of tasks in the tasks array returned with an error
- 型: numbertasks
.cost cost of the task, USD
- 型: objecttasks
.data contains the same parameters that you specified in the POST request
- 型: stringtasks
.id task identifier unique task identifier in our system in the UUID format
- 型: array string[]tasks
.path URL path
- 型: array string[]tasks
.result array of results
- 型: integertasks
.result _count number of elements in the result array
- 型: stringtasks
.result .asin ASIN in a POST array
- 型: array string[]tasks
.result .items contains detected Amazon product competitors and related data
- 型: integertasks
.result .items _count the number of results returned in the items array
- 型: objecttasks
.result .items .keyword _data keyword data for the returned keyword
- 型: stringtasks
.result .items .keyword _data .keyword returned keyword
- 型: objecttasks
.result .items .keyword _data .keyword _info keyword info for the returned keyword
- 型: stringtasks
.result .items .keyword _data .keyword _info .last _updated _time date and time when keyword data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”; example: 2019-11-15 12:57:46 +00:00
- 型: stringtasks
.result .items .keyword _data .keyword _info .se _type search engine type
- 型: integertasks
.result .items .keyword _data .keyword _info .search _volume average monthly search volume rate represents the (approximate) number of searches for the returned keyword on Amazon
- 型: stringtasks
.result .items .keyword _data .language _code language code in a POST array
- 型: integertasks
.result .items .keyword _data .location _code location code in a POST array
- 型: stringtasks
.result .items .keyword _data .se _type search engine type
- 型: objecttasks
.result .items .ranked _serp _element contains data on the products’s SERP element found for the returned keyword
- 型: stringtasks
.result .items .ranked _serp _element .check _url direct URL to Amazon results you can use it to make sure that we provided accurate results
- 型: stringtasks
.result .items .ranked _serp _element .last _updated _time date and time when SERP data was last updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time previous to the most recent update of SERP data in the ISO 8601 format: “YYYY-MM-DDThh:mm:ss.sssssssZ” example: 2020-09-12T00:07:43.0733218Z
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .asin ASIN of the product learn more about ASIN in this help center guide
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .currency currency in the ISO format example: USD
- 型: objecttasks
.result .items .ranked _serp _element .previous _updated _time .delivery _info delivery information delivery information including free and fast delivery date ranges
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .delivery _info .delivery _message delivery information message accompanying the delivery information as posted by the seller
- 型: objecttasks
.result .items .ranked _serp _element .previous _updated _time .delivery _info .delivery _price price for the delivery price of the delivery based on the location you specified in the POST request; if free delivery is available, the value is null
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .delivery _info .delivery _price .currency currency in the ISO format
- 型: numbertasks
.result .items .ranked _serp _element .previous _updated _time .delivery _info .delivery _price .current current delivery price
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .delivery _info .delivery _price .displayed _price price line provided as displayed in Amazon listing
- 型: booleantasks
.result .items .ranked _serp _element .previous _updated _time .delivery _info .delivery _price .is _price _range indicates whether the delivery price is a range
- 型: numbertasks
.result .items .ranked _serp _element .previous _updated _time .delivery _info .delivery _price .max _value maximum undiscounted delivery price
- 型: numbertasks
.result .items .ranked _serp _element .previous _updated _time .delivery _info .delivery _price .regular regular undiscounted delivery price
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .description description of the product
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .domain Amazon domain
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .image _url URL of the product image featured in the results
- 型: booleantasks
.result .items .ranked _serp _element .previous _updated _time .is _amazon _choice “Amazon’s choice” label if the value is true, the product is marked with the “Amazon’s choice” label
- 型: booleantasks
.result .items .ranked _serp _element .previous _updated _time .is _best _seller “Best Seller” label if the value is true, the product is marked with the “Best Seller” label
- 型: array string[]tasks
.result .items .ranked _serp _element .previous _updated _time .items contains
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .items .image _alt the alt tag of the product image featured in the results
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .items .image _url URL of the product image featured in the results
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .items .title product title
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .items .type type of element = ‘related_searches_element’
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .items .url the URL of the product page
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .position the alignment of the element in Amazon SERP can take the following values: left, right
- 型: numbertasks
.result .items .ranked _serp _element .previous _updated _time .price _from the regular price of a product example: 49.98
- 型: numbertasks
.result .items .ranked _serp _element .previous _updated _time .price _to the upper limit of the product price range example: 384.99
- 型: integertasks
.result .items .ranked _serp _element .previous _updated _time .rank _absolute absolute rank in Amazon SERP absolute position among all the elements in SERP
- 型: integertasks
.result .items .ranked _serp _element .previous _updated _time .rank _group position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
- 型: objecttasks
.result .items .ranked _serp _element .previous _updated _time .rating the item’s rating the popularity rate based on reviews and displayed in SERP
- 型: integertasks
.result .items .ranked _serp _element .previous _updated _time .rating .rating _max the maximum value for a rating_type
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .rating .rating _type the type of rating here you can find the following elements: Max5, Percents, CustomMax
- 型: integertasks
.result .items .ranked _serp _element .previous _updated _time .rating .value the value of the rating
- 型: integertasks
.result .items .ranked _serp _element .previous _updated _time .rating .votes _count the amount of feedback
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .se _type search engine type
- 型: array string[]tasks
.result .items .ranked _serp _element .previous _updated _time .special _offers special offer details contains special offer details, including coupon and Subscribe & Save discounts
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .title product title
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .type type of element = ‘related_searches’
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .url URL of the product page
- 型: stringtasks
.result .items .ranked _serp _element .previous _updated _time .xpath the XPath of the element
- 型: integertasks
.result .items .ranked _serp _element .se _results _count total number of results in Amazon SERP
- 型: stringtasks
.result .items .ranked _serp _element .se _type search engine type
- 型: objecttasks
.result .items .ranked _serp _element .serp _item contains data on the SERP element the list of supported SERP elements can be found below
- 型: array string[]tasks
.result .items .ranked _serp _element .serp _item _types direct URL to Amazon results contains types of all search results (items) found in the returned SERP; possible item types: amazon_serp, amazon_paid, editorial_recommendations, top_rated_from_our_brands, related_searches
- 型: stringtasks
.result .items .ranked _serp _element .serp _item .asin ASIN of the product learn more about ASIN in this help center guide
- 型: stringtasks
.result .items .ranked _serp _element .serp _item .currency currency in the ISO format example: USD
- 型: objecttasks
.result .items .ranked _serp _element .serp _item .delivery _info delivery information delivery information including free and fast delivery date ranges
- 型: stringtasks
.result .items .ranked _serp _element .serp _item .delivery _info .delivery _message delivery information message accompanying the delivery information as posted by the seller
- 型: objecttasks
.result .items .ranked _serp _element .serp _item .delivery _info .delivery _price price for the delivery price of the delivery based on the location you specified in the POST request; if free delivery is available, the value is null
- 型: stringtasks
.result .items .ranked _serp _element .serp _item .delivery _info .delivery _price .currency currency in the ISO format
- 型: numbertasks
.result .items .ranked _serp _element .serp _item .delivery _info .delivery _price .current current delivery price
- 型: stringtasks
.result .items .ranked _serp _element .serp _item .delivery _info .delivery _price .displayed _price price line provided as displayed in Amazon listing
- 型: booleantasks
.result .items .ranked _serp _element .serp _item .delivery _info .delivery _price .is _price _range indicates whether the delivery price is a range
- 型: numbertasks
.result .items .ranked _serp _element .serp _item .delivery _info .delivery _price .max _value maximum undiscounted delivery price
- 型: numbertasks
.result .items .ranked _serp _element .serp _item .delivery _info .delivery _price .regular regular undiscounted delivery price
- 型: stringtasks
.result .items .ranked _serp _element .serp _item .description description of the product
- 型: stringtasks
.result .items .ranked _serp _element .serp _item .domain Amazon domain
- 型: stringtasks
.result .items .ranked _serp _element .serp _item .image _url URL of the product image featured in the results
- 型: booleantasks
.result .items .ranked _serp _element .serp _item .is _amazon _choice “Amazon’s choice” label if the value is true, the product is marked with the “Amazon’s choice” label
- 型: booleantasks
.result .items .ranked _serp _element .serp _item .is _best _seller “Best Seller” label if the value is true, the product is marked with the “Best Seller” label
- 型: stringtasks
.result .items .ranked _serp _element .serp _item .position the alignment of the element in Amazon SERP can take the following values: left, right
- 型: numbertasks
.result .items .ranked _serp _element .serp _item .price _from the regular price of a product example: 49.98
- 型: numbertasks
.result .items .ranked _serp _element .serp _item .price _to the upper limit of the product price range example: 384.99
- 型: integertasks
.result .items .ranked _serp _element .serp _item .rank _absolute absolute rank in Amazon SERP absolute position among all the elements in SERP
- 型: integertasks
.result .items .ranked _serp _element .serp _item .rank _group position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
- 型: objecttasks
.result .items .ranked _serp _element .serp _item .rating the item’s rating the popularity rate based on reviews and displayed in SERP
- 型: integertasks
.result .items .ranked _serp _element .serp _item .rating .rating _max the maximum value for a rating_type
- 型: stringtasks
.result .items .ranked _serp _element .serp _item .rating .rating _type the type of rating here you can find the following elements: Max5, Percents, CustomMax
- 型: integertasks
.result .items .ranked _serp _element .serp _item .rating .value the value of the rating
- 型: integertasks
.result .items .ranked _serp _element .serp _item .rating .votes _count the amount of feedback
- 型: stringtasks
.result .items .ranked _serp _element .serp _item .se _type search engine type
- 型: array string[]tasks
.result .items .ranked _serp _element .serp _item .special _offers special offer details contains special offer details, including coupon and Subscribe & Save discounts
- 型: stringtasks
.result .items .ranked _serp _element .serp _item .title product title
- 型: stringtasks
.result .items .ranked _serp _element .serp _item .type type of element = ‘amazon_serp’
- 型: stringtasks
.result .items .ranked _serp _element .serp _item .url URL of the product page
- 型: stringtasks
.result .items .ranked _serp _element .serp _item .xpath the XPath of the element
- 型: stringtasks
.result .items .se _type search engine type
- 型: stringtasks
.result .language _code language code in a POST array if there is no data, then the value is null
- 型: integertasks
.result .location _code location code in a POST array if there is no data, then the value is null
- 型: stringtasks
.result .se _type search engine type
- 型: integertasks
.result .total _count total amount of results in our database relevant to your request
- 型: integertasks
.status _code status code of the task generated by DataForSEO; can be within the following range: 10000-60000 you can find the full list of the response codes here
- 型: stringtasks
.status _message informational message of the task you can find the full list of general informational messages here
- 型: stringtasks
.time execution time, seconds
- 型: stringtime
execution time, seconds
- 型: stringversion
the current version of the API
application/json - 400
Bad request
- 401
Unauthorized
- 402
The request cannot proceed because a billing requirement is not met.
- 403
The account is not permitted to perform this operation.
- 429
Rate limit exceeded
- 500
Internal server error
- 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
The operation failed. Keep the response request ID when contacting Felo support.
curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/amazon/ranked_keywords/live \
--request POST \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
--data '[
{},
{}
]'
{
"version": "string",
"status_code": 1,
"status_message": "string",
"time": "string",
"cost": 1,
"tasks_count": 1,
"tasks_error": 1,
"tasks": [
"string"
],
"tasks.id": "string",
"tasks.status_code": 1,
"tasks.status_message": "string",
"tasks.time": "string",
"tasks.cost": 1,
"tasks.result_count": 1,
"tasks.path": [
"string"
],
"tasks.data": {},
"tasks.result": [
"string"
],
"tasks.result.se_type": "string",
"tasks.result.asin": "string",
"tasks.result.location_code": 1,
"tasks.result.language_code": "string",
"tasks.result.total_count": 1,
"tasks.result.items_count": 1,
"tasks.result.items": [
"string"
],
"tasks.result.items.se_type": "string",
"tasks.result.items.keyword_data": {},
"tasks.result.items.keyword_data.se_type": "string",
"tasks.result.items.keyword_data.keyword": "string",
"tasks.result.items.keyword_data.location_code": 1,
"tasks.result.items.keyword_data.language_code": "string",
"tasks.result.items.keyword_data.keyword_info": {},
"tasks.result.items.keyword_data.keyword_info.se_type": "string",
"tasks.result.items.keyword_data.keyword_info.last_updated_time": "string",
"tasks.result.items.keyword_data.keyword_info.search_volume": 1,
"tasks.result.items.ranked_serp_element": {},
"tasks.result.items.ranked_serp_element.se_type": "string",
"tasks.result.items.ranked_serp_element.serp_item": {},
"tasks.result.items.ranked_serp_element.serp_item.se_type": "string",
"tasks.result.items.ranked_serp_element.serp_item.type": "string",
"tasks.result.items.ranked_serp_element.serp_item.rank_group": 1,
"tasks.result.items.ranked_serp_element.serp_item.rank_absolute": 1,
"tasks.result.items.ranked_serp_element.serp_item.position": "string",
"tasks.result.items.ranked_serp_element.serp_item.xpath": "string",
"tasks.result.items.ranked_serp_element.serp_item.domain": "string",
"tasks.result.items.ranked_serp_element.serp_item.title": "string",
"tasks.result.items.ranked_serp_element.serp_item.url": "string",
"tasks.result.items.ranked_serp_element.serp_item.description": "string",
"tasks.result.items.ranked_serp_element.serp_item.asin": "string",
"tasks.result.items.ranked_serp_element.serp_item.image_url": "string",
"tasks.result.items.ranked_serp_element.serp_item.price_from": 1,
"tasks.result.items.ranked_serp_element.serp_item.price_to": 1,
"tasks.result.items.ranked_serp_element.serp_item.currency": "string",
"tasks.result.items.ranked_serp_element.serp_item.special_offers": [
"string"
],
"tasks.result.items.ranked_serp_element.serp_item.is_best_seller": true,
"tasks.result.items.ranked_serp_element.serp_item.is_amazon_choice": true,
"tasks.result.items.ranked_serp_element.serp_item.rating": {},
"tasks.result.items.ranked_serp_element.serp_item.rating.rating_type": "string",
"tasks.result.items.ranked_serp_element.serp_item.rating.value": 1,
"tasks.result.items.ranked_serp_element.serp_item.rating.votes_count": 1,
"tasks.result.items.ranked_serp_element.serp_item.rating.rating_max": 1,
"tasks.result.items.ranked_serp_element.serp_item.delivery_info": {},
"tasks.result.items.ranked_serp_element.serp_item.delivery_info.delivery_message": "string",
"tasks.result.items.ranked_serp_element.serp_item.delivery_info.delivery_price": {},
"tasks.result.items.ranked_serp_element.serp_item.delivery_info.delivery_price.current": 1,
"tasks.result.items.ranked_serp_element.serp_item.delivery_info.delivery_price.regular": 1,
"tasks.result.items.ranked_serp_element.serp_item.delivery_info.delivery_price.max_value": 1,
"tasks.result.items.ranked_serp_element.serp_item.delivery_info.delivery_price.currency": "string",
"tasks.result.items.ranked_serp_element.serp_item.delivery_info.delivery_price.is_price_range": true,
"tasks.result.items.ranked_serp_element.serp_item.delivery_info.delivery_price.displayed_price": "string",
"tasks.result.items.ranked_serp_element.check_url": "string",
"tasks.result.items.ranked_serp_element.serp_item_types": [
"string"
],
"tasks.result.items.ranked_serp_element.se_results_count": 1,
"tasks.result.items.ranked_serp_element.last_updated_time": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.se_type": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.type": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.rank_group": 1,
"tasks.result.items.ranked_serp_element.previous_updated_time.rank_absolute": 1,
"tasks.result.items.ranked_serp_element.previous_updated_time.position": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.xpath": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.domain": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.title": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.url": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.description": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.asin": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.image_url": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.price_from": 1,
"tasks.result.items.ranked_serp_element.previous_updated_time.price_to": 1,
"tasks.result.items.ranked_serp_element.previous_updated_time.currency": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.special_offers": [
"string"
],
"tasks.result.items.ranked_serp_element.previous_updated_time.is_best_seller": true,
"tasks.result.items.ranked_serp_element.previous_updated_time.is_amazon_choice": true,
"tasks.result.items.ranked_serp_element.previous_updated_time.rating": {},
"tasks.result.items.ranked_serp_element.previous_updated_time.rating.rating_type": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.rating.value": 1,
"tasks.result.items.ranked_serp_element.previous_updated_time.rating.votes_count": 1,
"tasks.result.items.ranked_serp_element.previous_updated_time.rating.rating_max": 1,
"tasks.result.items.ranked_serp_element.previous_updated_time.delivery_info": {},
"tasks.result.items.ranked_serp_element.previous_updated_time.delivery_info.delivery_message": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.delivery_info.delivery_price": {},
"tasks.result.items.ranked_serp_element.previous_updated_time.delivery_info.delivery_price.current": 1,
"tasks.result.items.ranked_serp_element.previous_updated_time.delivery_info.delivery_price.regular": 1,
"tasks.result.items.ranked_serp_element.previous_updated_time.delivery_info.delivery_price.max_value": 1,
"tasks.result.items.ranked_serp_element.previous_updated_time.delivery_info.delivery_price.currency": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.delivery_info.delivery_price.is_price_range": true,
"tasks.result.items.ranked_serp_element.previous_updated_time.delivery_info.delivery_price.displayed_price": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.items": [
"string"
],
"tasks.result.items.ranked_serp_element.previous_updated_time.items.type": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.items.title": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.items.url": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.items.image_alt": "string",
"tasks.result.items.ranked_serp_element.previous_updated_time.items.image_url": "string"
}