Data API / DataForSEO / DataForSEO Labs

Product Competitors

Amazon products competing with a given product on shared search terms. 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. For the shared terms themselves use post_dataforseo_labs_amazon_product_kw_overlap_live.

Parameters

No path, query, or header parameters.

Request body

asinstringRequired
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_namestringOptional
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_codeintegerOptional
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_namestringOptional
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_codestringOptional
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
limitintegerOptional
the maximum number of products in the results array optional field default value: 100; maximum value: 1000
filtersarrayOptional
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, ilike, not_ilike, like, not_like, match, not_match you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: ["full_metrics.amazon_serp.pos_1",">", 20] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide
order_bystring[]Optional
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: ["full_metrics.amazon_serp.pos_1,desc"] 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: ["full_metrics.amazon_serp.pos_1,desc","avg_position,desc"] default rule: ["ranked_serp_element.serp_item.rank_group,asc"]
offsetintegerOptional
offset in the results array of returned product competitors optional field default value: 0 if you specify the 10 value, the first ten product competitors in the results array will be omitted and the data will be provided for the successive product competitors
tagstringOptional
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 request

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/amazon/product_competitors/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,
  "filters": "<string>",
  "order_by": [
    "<string>"
  ]
}'

Response

Response fields

versionstringOptional
the current version of the API
status_codeintegerOptional
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_messagestringOptional
general informational message you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
total tasks cost, USD
tasks_countintegerOptional
the number of tasks in the tasks array
tasks_errorintegerOptional
the number of tasks in the tasks array returned with an error
tasksstring[]Optional
array of tasks
idstringOptional
task identifier unique task identifier in our system in the UUID format
status_codeintegerOptional
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_messagestringOptional
informational message of the task you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
cost of the task, USD
result_countintegerOptional
number of elements in the result array
pathstring[]Optional
URL path
dataobjectOptional
contains the same parameters that you specified in the POST request
resultstring[]Optional
array of results
se_typestringOptional
search engine type
asinstringOptional
ASIN in a POST array
location_codeintegerOptional
location code in a POST array if there is no data, then the value is null
language_codestringOptional
language code in a POST array if there is no data, then the value is null
total_countintegerOptional
total amount of results in our database relevant to your request
items_countintegerOptional
the number of results returned in the items array
itemsstring[]Optional
contains detected Amazon product competitors and related data
se_typestringOptional
search engine type
asinstringOptional
ASIN of the product unique product identifier on Amazon; for more information, refer to this help center guide
avg_positionnumberOptional
average position of the product in Amazon SERP Note: average position is calculated for intersected keywords only; the value for a given product may differ when combined with different target products
sum_positionintegerOptional
sum of all product positions in Amazon SERP Note: average position is calculated for intersected keywords only; the value for a given product may differ when combined with different target products
intersectionsintegerOptional
number of intersecting keywords
competitor_metricsobjectOptional
metrics for intersecting keywords ranking data relevant to the keywords that the provided asin shares with the target asin; Note: in this object ranking data is provided for the returned competitor’s asin
amazon_serpobjectOptional
ranking data from Amazon organic SERP
pos_1integerOptional
number of organic SERPs where the product ranks #1
pos_2_3integerOptional
number of organic SERPs where the product ranks #2-3
pos_4_10integerOptional
number of organic SERPs where the product ranks #4-10
pos_11_100integerOptional
number of organic SERPs where the product ranks #11-100
countintegerOptional
total count of Amazon organic SERPs that contain the product
search_volumeintegerOptional
total search volume of the product’s ranking keywords in organic SERP
amazon_paidobjectOptional
ranking data from Amazon paid SERP
pos_1integerOptional
number of paid SERPs where the product ranks #1
pos_2_3integerOptional
number of paid SERPs where the product ranks #2-3
pos_4_10integerOptional
number of paid SERPs where the product ranks #4-10
pos_11_100integerOptional
number of paid SERPs where the product ranks #11-100
countintegerOptional
total count of Amazon paid SERPs that contain the product
search_volumeintegerOptional
total search volume of the product’s ranking keywords in paid SERP
full_metricsobjectOptional
metrics for all keywords of the product full overview of ranking data relevant to all keywords that the provided asin is ranking for
amazon_serpobjectOptional
ranking data from Amazon organic SERP
pos_1integerOptional
number of organic SERPs where the product ranks #1
pos_2_3integerOptional
number of organic SERPs where the product ranks #2-3
pos_4_10integerOptional
number of organic SERPs where the product ranks #4-10
pos_11_100integerOptional
number of organic SERPs where the product ranks #11-100
countintegerOptional
total count of Amazon organic SERPs that contain the product
search_volumeintegerOptional
total search volume of the product’s ranking keywords in organic SERP
amazon_paidobjectOptional
ranking data from Amazon paid SERP
pos_1integerOptional
number of paid SERPs where the product ranks #1
pos_2_3integerOptional
number of paid SERPs where the product ranks #2-3
pos_4_10integerOptional
number of paid SERPs where the product ranks #4-10
pos_11_100integerOptional
number of paid SERPs where the product ranks #11-100
countintegerOptional
total count of Amazon paid SERPs that contain the product
search_volumeintegerOptional
total search volume of the product’s ranking keywords in paid SERP