v0.1.0-beta

OpenAPI 3.1.0

Product Competitors

Felo API Support

MIT

Server

https://openapi.felo.ai

Client Libraries

Shell Curl

DataForSEO

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Operations

post/v1/beta/dataforseo/dataforseo_labs/amazon/product_competitors/live

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.

Body

required

application/json

Type: array object[]
- Type: object
  asin
  Type: string
  required
  
  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
  Type: 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, 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
  
  language_code
  Type: string
  
  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_name
  Type: string
  
  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
  Type: integer
  
  the maximum number of products in the results array optional field default value: 100; maximum value: 1000
  
  location_code
  Type: integer
  
  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_name
  Type: string
  
  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
  Type: integer
  
  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
  
  order_by
  Type: array string[]
  
  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"]
  
  tag
  Type: 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
  
  Empty object
  Empty object

Responses

200
Type: object

Successful response
cost
Type: number

total tasks cost, USD

status_code
Type: integer

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_message
Type: string

general informational message you can find the full list of general informational messages here

tasks
Type: array string[]

array of tasks

tasks_count
Type: integer

the number of tasks in the tasks array

tasks_error
Type: integer

the number of tasks in the tasks array returned with an error

tasks.cost
Type: number

cost of the task, USD

tasks.data
Type: object

contains the same parameters that you specified in the POST request

tasks.id
Type: string

task identifier unique task identifier in our system in the UUID format

tasks.path
Type: array string[]

URL path

tasks.result
Type: array string[]

array of results

tasks.result_count
Type: integer

number of elements in the result array

tasks.result.asin
Type: string

ASIN in a POST array

tasks.result.items
Type: array string[]

contains detected Amazon product competitors and related data

tasks.result.items_count
Type: integer

the number of results returned in the items array

tasks.result.items.asin
Type: string

ASIN of the product unique product identifier on Amazon; for more information, refer to this help center guide

tasks.result.items.avg_position
Type: number

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

tasks.result.items.competitor_metrics
Type: object

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

tasks.result.items.competitor_metrics.amazon_paid
Type: object

ranking data from Amazon paid SERP

tasks.result.items.competitor_metrics.amazon_paid.count
Type: integer

total count of Amazon paid SERPs that contain the product

tasks.result.items.competitor_metrics.amazon_paid.pos_1
Type: integer

number of paid SERPs where the product ranks #1

tasks.result.items.competitor_metrics.amazon_paid.pos_11_100
Type: integer

number of paid SERPs where the product ranks #11-100

tasks.result.items.competitor_metrics.amazon_paid.pos_2_3
Type: integer

number of paid SERPs where the product ranks #2-3

tasks.result.items.competitor_metrics.amazon_paid.pos_4_10
Type: integer

number of paid SERPs where the product ranks #4-10

tasks.result.items.competitor_metrics.amazon_paid.search_volume
Type: integer

total search volume of the product’s ranking keywords in paid SERP

tasks.result.items.competitor_metrics.amazon_serp
Type: object

ranking data from Amazon organic SERP

tasks.result.items.competitor_metrics.amazon_serp.count
Type: integer

total count of Amazon organic SERPs that contain the product

tasks.result.items.competitor_metrics.amazon_serp.pos_1
Type: integer

number of organic SERPs where the product ranks #1

tasks.result.items.competitor_metrics.amazon_serp.pos_11_100
Type: integer

number of organic SERPs where the product ranks #11-100

tasks.result.items.competitor_metrics.amazon_serp.pos_2_3
Type: integer

number of organic SERPs where the product ranks #2-3

tasks.result.items.competitor_metrics.amazon_serp.pos_4_10
Type: integer

number of organic SERPs where the product ranks #4-10

tasks.result.items.competitor_metrics.amazon_serp.search_volume
Type: integer

total search volume of the product’s ranking keywords in organic SERP

tasks.result.items.full_metrics
Type: object

metrics for all keywords of the product full overview of ranking data relevant to all keywords that the provided asin is ranking for

tasks.result.items.full_metrics.amazon_paid
Type: object

ranking data from Amazon paid SERP

tasks.result.items.full_metrics.amazon_paid.count
Type: integer

total count of Amazon paid SERPs that contain the product

tasks.result.items.full_metrics.amazon_paid.pos_1
Type: integer

number of paid SERPs where the product ranks #1

tasks.result.items.full_metrics.amazon_paid.pos_11_100
Type: integer

number of paid SERPs where the product ranks #11-100

tasks.result.items.full_metrics.amazon_paid.pos_2_3
Type: integer

number of paid SERPs where the product ranks #2-3

tasks.result.items.full_metrics.amazon_paid.pos_4_10
Type: integer

number of paid SERPs where the product ranks #4-10

tasks.result.items.full_metrics.amazon_paid.search_volume
Type: integer

total search volume of the product’s ranking keywords in paid SERP

tasks.result.items.full_metrics.amazon_serp
Type: object

ranking data from Amazon organic SERP

tasks.result.items.full_metrics.amazon_serp.count
Type: integer

total count of Amazon organic SERPs that contain the product

tasks.result.items.full_metrics.amazon_serp.pos_1
Type: integer

number of organic SERPs where the product ranks #1

tasks.result.items.full_metrics.amazon_serp.pos_11_100
Type: integer

number of organic SERPs where the product ranks #11-100

tasks.result.items.full_metrics.amazon_serp.pos_2_3
Type: integer

number of organic SERPs where the product ranks #2-3

tasks.result.items.full_metrics.amazon_serp.pos_4_10
Type: integer

number of organic SERPs where the product ranks #4-10

tasks.result.items.full_metrics.amazon_serp.search_volume
Type: integer

total search volume of the product’s ranking keywords in organic SERP

tasks.result.items.intersections
Type: integer

number of intersecting keywords

tasks.result.items.se_type
Type: string

search engine type

tasks.result.items.sum_position
Type: integer

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

tasks.result.language_code
Type: string

language code in a POST array if there is no data, then the value is null

tasks.result.location_code
Type: integer

location code in a POST array if there is no data, then the value is null

tasks.result.se_type
Type: string

search engine type

tasks.result.total_count
Type: integer

total amount of results in our database relevant to your request

tasks.status_code
Type: integer

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

tasks.status_message
Type: string

informational message of the task you can find the full list of general informational messages here

tasks.time
Type: string

execution time, seconds

time
Type: string

execution time, seconds

version
Type: string

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.

post/v1/beta/dataforseo/dataforseo_labs/amazon/product_competitors/live

curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/amazon/product_competitors/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {},
  {}
]'

Show Schema

{
  "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.asin": "string",
  "tasks.result.items.avg_position": 1,
  "tasks.result.items.sum_position": 1,
  "tasks.result.items.intersections": 1,
  "tasks.result.items.competitor_metrics": {},
  "tasks.result.items.competitor_metrics.amazon_serp": {},
  "tasks.result.items.competitor_metrics.amazon_serp.pos_1": 1,
  "tasks.result.items.competitor_metrics.amazon_serp.pos_2_3": 1,
  "tasks.result.items.competitor_metrics.amazon_serp.pos_4_10": 1,
  "tasks.result.items.competitor_metrics.amazon_serp.pos_11_100": 1,
  "tasks.result.items.competitor_metrics.amazon_serp.count": 1,
  "tasks.result.items.competitor_metrics.amazon_serp.search_volume": 1,
  "tasks.result.items.competitor_metrics.amazon_paid": {},
  "tasks.result.items.competitor_metrics.amazon_paid.pos_1": 1,
  "tasks.result.items.competitor_metrics.amazon_paid.pos_2_3": 1,
  "tasks.result.items.competitor_metrics.amazon_paid.pos_4_10": 1,
  "tasks.result.items.competitor_metrics.amazon_paid.pos_11_100": 1,
  "tasks.result.items.competitor_metrics.amazon_paid.count": 1,
  "tasks.result.items.competitor_metrics.amazon_paid.search_volume": 1,
  "tasks.result.items.full_metrics": {},
  "tasks.result.items.full_metrics.amazon_serp": {},
  "tasks.result.items.full_metrics.amazon_serp.pos_1": 1,
  "tasks.result.items.full_metrics.amazon_serp.pos_2_3": 1,
  "tasks.result.items.full_metrics.amazon_serp.pos_4_10": 1,
  "tasks.result.items.full_metrics.amazon_serp.pos_11_100": 1,
  "tasks.result.items.full_metrics.amazon_serp.count": 1,
  "tasks.result.items.full_metrics.amazon_serp.search_volume": 1,
  "tasks.result.items.full_metrics.amazon_paid": {},
  "tasks.result.items.full_metrics.amazon_paid.pos_1": 1,
  "tasks.result.items.full_metrics.amazon_paid.pos_2_3": 1,
  "tasks.result.items.full_metrics.amazon_paid.pos_4_10": 1,
  "tasks.result.items.full_metrics.amazon_paid.pos_11_100": 1,
  "tasks.result.items.full_metrics.amazon_paid.count": 1,
  "tasks.result.items.full_metrics.amazon_paid.search_volume": 1
}

Successful response

Product Competitors

AuthenticationRequired

DataForSEO

Product Competitors