Felo API PlatformFelo API Platform
All DataForSEO endpoints
v0.2.0-beta
OpenAPI 3.1.0

Keyword Intersections

Server:https://openapi.felo.ai
Client Libraries

DataForSEO

​

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

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.

Pricing reference

  • Metering: Reported response cost.
  • Reference request estimate: USD 0.1356.
  • Reference customer multiplier: 1.0. Do not apply it again to a settled customer amount.

Reference metadata only, not an account quote, a guaranteed price or a spending cap. Resource credits are not Felo credits. Final charges follow Felo billing records.

Body
application/json
  • Type: array (object | null)[]
    • asins
      Type: object | null

      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

      • propertyName
        Type: string | null
    • filters
      Type: array (object | null)[] | null

      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","<", 10]

      for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide

      Empty object
    • intersection_mode
      Type: string | null

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

    • language_code
      Type: string | null

      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 | null

      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 Kingdom

    • offset
      Type: integer | null

      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

    • order_by
      Type: array string[] | null

      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"]

    • tag
      Type: string | null

      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

Responses
  • 200
    Type: object | null · Response36Afe1097B20_DataforseoLabsAmazonProductKeywordIntersectionsLiveResponseInfo
    • cost
      Type: number | null Format: double

      total tasks cost, USD

    • status_code
      Type: integer | null

      general status code you can find the full list of the response codes here

    • status_message
      Type: string | null

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

    • tasks
      Type: array (object | null)[] | null

      array of tasks

      • Type: object | null · Response36Afe1097B20_DataforseoLabsAmazonProductKeywordIntersectionsLiveTaskInfo
        • cost
          Type: number | null Format: double

          total tasks cost, USD

        • data
          Type: object | null

          contains the same parameters that you specified in the POST request

          • propertyName
            Type: object | null
        • id
          Type: string | null

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

        • path
          Type: array (string | null)[] | null

          URL path

        • result
          Type: array (object | null)[] | null

          array of results

          • asins
            Type: object | null

            ASINs in a POST array

            • propertyName
              Type: string | null
          • items
            Type: array (object | null)[] | null

            contains detected Amazon product competitors and related data

            • intersection_result
              Type: object | null

              data on the intersection

              • propertyName
                Type: object | null · Response36Afe1097B20_AmazonInfo
                • asin
                  Type: string | null

                  ASIN in a POST array

                • bought_past_month
                  Type: integer | null

                  Integer numbers.

                • currency
                  Type: string | null

                  currency in the ISO format
                  example:
                  USD

                • delivery_info
                  Type: object | null · Response36Afe1097B20_AmazonDeliveryInfo

                  delivery information
                  delivery information including free and fast delivery date ranges

                  • delivery_date_from
                    Type: string | null

                    the earliest date when the product can be shipped

                  • delivery_date_to
                    Type: string | null

                    the latest date when the product can be delivered

                  • delivery_message
                    Type: string | null

                    message accompanying the delivery information as posted by the seller

                  • delivery_price
                    Type: object | null · Response36Afe1097B20_PriceInfo

                    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

                    • currency
                      Type: string | null

                      currency of the listed price ISO code of the currency applied to the price

                    • current
                      Type: number | null Format: double

                      current price indicates the current price of the product or service featured in the result

                    • displayed_price
                      Type: string | null

                      price string in the result raw price string as provided in the result

                    • is_price_range
                      Type: boolean | null

                      price is provided as a range indicates whether a price is provided in a range

                    • max_value
                      Type: number | null Format: double

                      the maximum price the maximum price of the product or service as indicated in the result

                    • regular
                      Type: number | null Format: double

                      regular price indicates the regular price of the product or service with no discounts applied

                  • fastest_delivery_date_from
                    Type: string | null

                    the earliest date when the product can be delivered with a fast delivery option

                  • fastest_delivery_date_to
                    Type: string | null

                    the latest date when the product can be delivered with a fast delivery option

                • domain
                  Type: string | null

                  Amazon domain

                • image_url
                  Type: string | null

                  URL of the product image featured in the results

                • is_amazon_choice
                  Type: boolean | null

                  "Amazon's choice" label
                  if the value is true, the product is marked with the "Amazon's choice" label

                • is_best_seller
                  Type: boolean | null

                  "Best Seller" label
                  if the value is true, the product is marked with the "Best Seller" label

                • position
                  Type: string | null

                  the alignment of the element in Amazon SERP
                  can take the following values:
                  left, right

                • price_from
                  Type: number | null

                  the regular price of a product
                  example:
                  49.98

                • price_to
                  Type: number | null

                  the upper limit of the product price range
                  example:
                  384.99

                • rank_absolute
                  Type: integer | null

                  absolute rank in Amazon SERP
                  absolute position among all the elements in SERP

                • rank_group
                  Type: integer | null

                  position within a group of elements with identical type values
                  positions of elements with different type values are omitted from rank_group

                • rating
                  Type: object | null · Response36Afe1097B20_RatingInfo

                  the item's rating
                  the popularity rate based on reviews and displayed in SERP

                  • rating_max
                    Type: integer | null

                    the maximum value for a rating_type

                  • rating_type
                    Type: string | null

                    the type of rating here you can find the following elements: Max5, Percents, CustomMax

                  • value
                    Type: number | null Format: float

                    the value of the rating

                  • votes_count
                    Type: integer | null Format: int64

                    the amount of feedback

                • se_type
                  Type: string | null

                  search engine type

                • special_offers
                  Type: array (string | null)[] | null

                  special offer details
                  contains special offer details, including coupon and Subscribe & Save discounts

                • title
                  Type: string | null

                  product title

                • type
                  Type: string | null

                  type of element

                • url
                  Type: string | null

                  URL of the product page

                • xpath
                  Type: string | null

                  the XPath of the element

            • keyword_data
              Type: object | null · Response36Afe1097B20_AmazonKeywordData

              keyword data for the returned keyword

              • keyword
                Type: string | null

                related keyword

              • keyword_info
                Type: object | null · Response36Afe1097B20_AmazonKeywordInfo

                keyword info for the returned keyword

                • last_updated_time
                  Type: string | null

                  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'

                • se_type
                  Type: string | null

                  search engine type

                • search_volume
                  Type: integer | null Format: int64

                  average monthly search volume rate represents the (approximate) number of searches for the provided keyword idea on Amazon

              • language_code
                Type: string | null

                language code in a POST array

              • location_code
                Type: integer | null Format: int64

                location code in a POST array

              • se_type
                Type: string | null

                search engine type

            • se_type
              Type: string | null

              search engine type

          • items_count
            Type: integer | null Format: int64

            the number of results returned in the items array

          • language_code
            Type: string | null

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

          • location_code
            Type: integer | null

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

          • se_type
            Type: string | null

            search engine type

          • total_count
            Type: integer | null Format: int64

            total amount of results in our database relevant to your request

        • result_count
          Type: integer | null Format: int64

          number of elements in the result array

        • status_code
          Type: integer | null

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

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

        • time
          Type: string | null

          execution time, seconds

    • tasks_count
      Type: integer | null Format: int64

      the number of tasks in the tasks array

    • tasks_error
      Type: integer | null Format: int64

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

    • time
      Type: string | null

      total execution time, seconds

    • version
      Type: string | null

      the current version of the API

    application/json
  • 400

    The request could not be processed. Check the request parameters.

  • 401

    A valid Felo API key is required.

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    A request or spending limit has been reached.

  • 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

    Error response; upstream passthrough responses may use provider formats

    application/json
Request Example for post/v1/beta/dataforseo/dataforseo_labs/amazon/product_keyword_intersections/live
curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/amazon/product_keyword_intersections/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "asins": {
      "1": "B09172433Z",
      "2": "B07GBZ4Q68",
      "3": "B07GCKQD77"
    },
    "language_name": "English",
    "location_code": 2840
  }
]'
{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        {
          "se_type": null,
          "asins": null,
          "location_code": null,
          "language_code": null,
          "total_count": null,
          "items_count": null,
          "items": [
            {
              "se_type": null,
              "keyword_data": "[Max Depth Exceeded]",
              "intersection_result": null
            }
          ]
        }
      ]
    }
  ]
}
Keyword Intersections

Need help?