データ API / DataForSEO / DataForSEO Labs

Product Rank Overview

Where a set of Amazon products rank overall - the product-level equivalent of a domain rank overview. This one takes no limit parameter, but it is priced per call rather than per item, so send the whole list at once. 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 keywords behind those rankings use post_dataforseo_labs_amazon_ranked_keywords_live.

パラメータ

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

リクエストボディ

asinsstring[]必須
product IDs to compare required field product IDs to receive ranking data for; the maximum number of ASINs you can specify in this array is 1000; you can receive the asin parameter by making a separate request to the Amazon Products endpoint Note: all letters in ASIN code must be specified in uppercase format; example: B01LW2SL7R
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
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/product_rank_overview/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "asins": [
    "<string>"
  ],
  "location_name": "<string>",
  "location_code": 0,
  "language_name": "<string>",
  "language_code": "<string>",
  "tag": "<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
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
asinstring任意
ASIN of the product unique product identifier on Amazon; for more information, refer to this help center guide
metricsobject任意
average keyword position of the product
amazon_serpobject任意
ranking data from Amazon organic SERP
pos_1integer任意
number of organic SERPs where the product ranks #1
pos_2_3integer任意
number of organic SERPs where the product ranks #2-3
pos_4_10integer任意
number of organic SERPs where the product ranks #4-10
pos_11_100integer任意
number of organic SERPs where the product ranks #11-100
countinteger任意
total count of Amazon organic SERPs that contain the product
search_volumeinteger任意
total search volume of the product’s ranking keywords in organic SERP
amazon_paidobject任意
ranking data from Amazon paid SERP
pos_1integer任意
number of paid SERPs where the product ranks #1
pos_2_3integer任意
number of paid SERPs where the product ranks #2-3
pos_4_10integer任意
number of paid SERPs where the product ranks #4-10
pos_11_100integer任意
number of paid SERPs where the product ranks #11-100
countinteger任意
total count of Amazon paid SERPs that contain the product
search_volumeinteger任意
total search volume of the product’s ranking keywords in paid SERP