Felo API PlatformFelo API Platform

数据 API / DataForSEO / DataForSEO Labs

Keyword Intersections

The Amazon search terms two or more products both rank 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. Where post_dataforseo_labs_amazon_product_competitors_live names the rivals, this names the terms they contest.

参数

没有路径、查询或请求头参数。

请求体

  • asinsobject必填

    asins of target products required field product IDs of the products for which you need to find keyword intersections; specify the ASINs as in the following example: "asins": { "1": "019005476X", "2": "0190074442" } the maximum number of ASINs you can specify in this object is 20; learn more about the parameter on this help center page

  • 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 Kingdom

  • 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

  • intersection_modestring可选

    mode for finding asin intersections optional field possible values: union, intersect; default value: intersect; learn more about the parameter in this help center guide

  • 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, 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: ["avg_position"," 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: ["sum_position,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: ["intersections,desc","avg_position,asc"] default rule: ["intersections,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/product_keyword_intersections/live" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "asins": {},
  "location_name": "<string>",
  "location_code": 0,
  "language_name": "<string>",
  "language_code": "<string>",
  "limit": 0,
  "intersection_mode": "<string>",
  "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

  • asinsobject可选

    ASINs 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

  • keyword_dataobject可选

    keyword data for the returned keyword

  • se_typestring可选

    search engine type

  • keywordstring可选

    returned keyword

  • location_codeinteger可选

    location in a POST array

  • language_codestring可选

    language in a POST array

  • keyword_infoobject可选

    keyword data 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

  • intersection_resultobject可选

    data on the intersection

  • $asin_numberobject可选

    intersection data for one of the ASINs in a POST request

  • 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