データ API / DataForSEO / DataForSEO Labs

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.

パラメータ

パス・クエリ・ヘッダーのパラメータはありません。

リクエストボディ

asinstring必須
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
location_namestring任意
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_codeinteger任意
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
language_namestring任意
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_codestring任意
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
limitinteger任意
the maximum number of products in the results array optional field default value: 100; maximum value: 1000
ignore_synonymsboolean任意
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
filtersarray任意
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
order_bystring[]任意
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"]
offsetinteger任意
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
tagstring任意
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

リクエスト例

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/amazon/ranked_keywords/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "asin": "<string>",
  "location_name": "<string>",
  "location_code": 0,
  "language_name": "<string>",
  "language_code": "<string>",
  "limit": 0,
  "ignore_synonyms": false,
  "filters": "<string>"
}'

レスポンス

レスポンスのフィールド

versionstring任意
the current version of the API
status_codeinteger任意
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
status_messagestring任意
general informational message you can find the full list of general informational messages here
timestring任意
execution time, seconds
costnumber任意
total tasks cost, USD
tasks_countinteger任意
the number of tasks in the tasks array
tasks_errorinteger任意
the number of tasks in the tasks array returned with an error
tasksstring[]任意
array of tasks
idstring任意
task identifier unique task identifier in our system in the UUID format
status_codeinteger任意
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
status_messagestring任意
informational message of the task you can find the full list of general informational messages here
timestring任意
execution time, seconds
costnumber任意
cost of the task, USD
result_countinteger任意
number of elements in the result array
pathstring[]任意
URL path
dataobject任意
contains the same parameters that you specified in the POST request
resultstring[]任意
array of results
se_typestring任意
search engine type
asinstring任意
ASIN in a POST array
location_codeinteger任意
location code in a POST array if there is no data, then the value is null
language_codestring任意
language code in a POST array if there is no data, then the value is null
total_countinteger任意
total amount of results in our database relevant to your request
items_countinteger任意
the number of results returned in the items array
itemsstring[]任意
contains detected Amazon product competitors and related data
se_typestring任意
search engine type
keyword_dataobject任意
keyword data for the returned keyword
se_typestring任意
search engine type
keywordstring任意
returned keyword
location_codeinteger任意
location code in a POST array
language_codestring任意
language code in a POST array
keyword_infoobject任意
keyword info for the returned keyword
se_typestring任意
search engine type
last_updated_timestring任意
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
search_volumeinteger任意
average monthly search volume rate represents the (approximate) number of searches for the returned keyword on Amazon
ranked_serp_elementobject任意
contains data on the products’s SERP element found for the returned keyword
se_typestring任意
search engine type
serp_itemobject任意
contains data on the SERP element the list of supported SERP elements can be found below
se_typestring任意
search engine type
typestring任意
type of element = ‘amazon_serp’
rank_groupinteger任意
position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
rank_absoluteinteger任意
absolute rank in Amazon SERP absolute position among all the elements in SERP
positionstring任意
the alignment of the element in Amazon SERP can take the following values: left, right
xpathstring任意
the XPath of the element
domainstring任意
Amazon domain
titlestring任意
product title
urlstring任意
URL of the product page
descriptionstring任意
description of the product
asinstring任意
ASIN of the product learn more about ASIN in this help center guide
image_urlstring任意
URL of the product image featured in the results
price_fromnumber任意
the regular price of a product example: 49.98
price_tonumber任意
the upper limit of the product price range example: 384.99
currencystring任意
currency in the ISO format example: USD
special_offersstring[]任意
special offer details contains special offer details, including coupon and Subscribe & Save discounts
is_best_sellerboolean任意
“Best Seller” label if the value is true, the product is marked with the “Best Seller” label
is_amazon_choiceboolean任意
“Amazon’s choice” label if the value is true, the product is marked with the “Amazon’s choice” label
ratingobject任意
the item’s rating the popularity rate based on reviews and displayed in SERP
rating_typestring任意
the type of rating here you can find the following elements: Max5, Percents, CustomMax
valueinteger任意
the value of the rating
votes_countinteger任意
the amount of feedback
rating_maxinteger任意
the maximum value for a rating_type
delivery_infoobject任意
delivery information delivery information including free and fast delivery date ranges
delivery_messagestring任意
delivery information message accompanying the delivery information as posted by the seller
delivery_priceobject任意
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
currentnumber任意
current delivery price
regularnumber任意
regular undiscounted delivery price
max_valuenumber任意
maximum undiscounted delivery price
currencystring任意
currency in the ISO format
is_price_rangeboolean任意
indicates whether the delivery price is a range
displayed_pricestring任意
price line provided as displayed in Amazon listing
check_urlstring任意
direct URL to Amazon results you can use it to make sure that we provided accurate results
serp_item_typesstring[]任意
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
se_results_countinteger任意
total number of results in Amazon SERP
last_updated_timestring任意
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_updated_timestring任意
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
se_typestring任意
search engine type
typestring任意
type of element = ‘related_searches’
rank_groupinteger任意
position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group
rank_absoluteinteger任意
absolute rank in Amazon SERP absolute position among all the elements in SERP
positionstring任意
the alignment of the element in Amazon SERP can take the following values: left, right
xpathstring任意
the XPath of the element
domainstring任意
Amazon domain
titlestring任意
product title
urlstring任意
URL of the product page
descriptionstring任意
description of the product
asinstring任意
ASIN of the product learn more about ASIN in this help center guide
image_urlstring任意
URL of the product image featured in the results
price_fromnumber任意
the regular price of a product example: 49.98
price_tonumber任意
the upper limit of the product price range example: 384.99
currencystring任意
currency in the ISO format example: USD
special_offersstring[]任意
special offer details contains special offer details, including coupon and Subscribe & Save discounts
is_best_sellerboolean任意
“Best Seller” label if the value is true, the product is marked with the “Best Seller” label
is_amazon_choiceboolean任意
“Amazon’s choice” label if the value is true, the product is marked with the “Amazon’s choice” label
ratingobject任意
the item’s rating the popularity rate based on reviews and displayed in SERP
rating_typestring任意
the type of rating here you can find the following elements: Max5, Percents, CustomMax
valueinteger任意
the value of the rating
votes_countinteger任意
the amount of feedback
rating_maxinteger任意
the maximum value for a rating_type
delivery_infoobject任意
delivery information delivery information including free and fast delivery date ranges
delivery_messagestring任意
delivery information message accompanying the delivery information as posted by the seller
delivery_priceobject任意
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
currentnumber任意
current delivery price
regularnumber任意
regular undiscounted delivery price
max_valuenumber任意
maximum undiscounted delivery price
currencystring任意
currency in the ISO format
is_price_rangeboolean任意
indicates whether the delivery price is a range
displayed_pricestring任意
price line provided as displayed in Amazon listing
itemsstring[]任意
contains
typestring任意
type of element = ‘related_searches_element’
titlestring任意
product title
urlstring任意
the URL of the product page
image_altstring任意
the alt tag of the product image featured in the results
image_urlstring任意
URL of the product image featured in the results