Ranked Keywords
This endpoint will provide you with a list of keywords the target product ranks for on Amazon.
Documentation Index
Fetch the complete documentation index at: https://aisa.one/docs/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
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
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
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
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
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
the maximum number of products in the results array optional field default value: 100; maximum value: 1000
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
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
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"]
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
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
Response
Successful response
the current version of the API
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
general informational message you can find the full list of general informational messages here
execution time, seconds
total tasks cost, USD
the number of tasks in the tasks array
the number of tasks in the tasks array returned with an error
array of tasks
task identifier unique task identifier in our system in the UUID format
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
informational message of the task you can find the full list of general informational messages here
execution time, seconds
cost of the task, USD
number of elements in the result array
URL path
contains the same parameters that you specified in the POST request
array of results
search engine type
ASIN in a POST array
location code in a POST array if there is no data, then the value is null
language code in a POST array if there is no data, then the value is null
total amount of results in our database relevant to your request
the number of results returned in the items array
contains detected Amazon product competitors and related data
search engine type
keyword data for the returned keyword
search engine type
returned keyword
location code in a POST array
language code in a POST array
keyword info for the returned keyword
search engine type
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
average monthly search volume rate represents the (approximate) number of searches for the returned keyword on Amazon
contains data on the products’s SERP element found for the returned keyword
search engine type
contains data on the SERP element the list of supported SERP elements can be found below
search engine type
type of element = ‘amazon_serp’
position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
absolute rank in Amazon SERP absolute position among all the elements in SERP
the alignment of the element in Amazon SERP can take the following values: left, right
the XPath of the element
Amazon domain
product title
URL of the product page
description of the product
ASIN of the product learn more about ASIN in this help center guide
URL of the product image featured in the results
the regular price of a product example: 49.98
the upper limit of the product price range example: 384.99
currency in the ISO format example: USD
special offer details contains special offer details, including coupon and Subscribe & Save discounts
“Best Seller” label if the value is true, the product is marked with the “Best Seller” label
“Amazon’s choice” label if the value is true, the product is marked with the “Amazon’s choice” label
the item’s rating the popularity rate based on reviews and displayed in SERP
the type of rating here you can find the following elements: Max5, Percents, CustomMax
the value of the rating
the amount of feedback
the maximum value for a rating_type
delivery information delivery information including free and fast delivery date ranges
delivery information message accompanying the delivery information as posted by the seller
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
current delivery price
regular undiscounted delivery price
maximum undiscounted delivery price
currency in the ISO format
indicates whether the delivery price is a range
price line provided as displayed in Amazon listing
direct URL to Amazon results you can use it to make sure that we provided accurate results
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
total number of results in Amazon SERP
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
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
search engine type
type of element = ‘related_searches’
position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
absolute rank in Amazon SERP absolute position among all the elements in SERP
the alignment of the element in Amazon SERP can take the following values: left, right
the XPath of the element
Amazon domain
product title
URL of the product page
description of the product
ASIN of the product learn more about ASIN in this help center guide
URL of the product image featured in the results
the regular price of a product example: 49.98
the upper limit of the product price range example: 384.99
currency in the ISO format example: USD
special offer details contains special offer details, including coupon and Subscribe & Save discounts
“Best Seller” label if the value is true, the product is marked with the “Best Seller” label
“Amazon’s choice” label if the value is true, the product is marked with the “Amazon’s choice” label
the item’s rating the popularity rate based on reviews and displayed in SERP
the type of rating here you can find the following elements: Max5, Percents, CustomMax
the value of the rating
the amount of feedback
the maximum value for a rating_type
delivery information delivery information including free and fast delivery date ranges
delivery information message accompanying the delivery information as posted by the seller
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
current delivery price
regular undiscounted delivery price
maximum undiscounted delivery price
currency in the ISO format
indicates whether the delivery price is a range
price line provided as displayed in Amazon listing
contains
type of element = ‘related_searches_element’
product title
the URL of the product page
the alt tag of the product image featured in the results
URL of the product image featured in the results