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

Product Rank Overview

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

DataForSEO

​

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

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.

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: array string[]

      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

    • 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

    • 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

    • 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_DataforseoLabsAmazonProductRankOverviewLiveResponseInfo
    • 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_DataforseoLabsAmazonProductRankOverviewLiveTaskInfo
        • 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

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

            contains detected Amazon product competitors and related data

            • asin
              Type: string | null

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

            • metrics
              Type: object | null · Response36Afe1097B20_AmazonMetricsBundleInfo

              average keyword position of the product

              • amazon_paid
                Type: object | null · Response36Afe1097B20_AppMetricsInfo

                ranking data from Amazon paid SERP

                • count
                  Type: integer | null Format: int64

                  total count of Amazon organic SERPs that contain the product

                • pos_1
                  Type: integer | null

                  number of organic SERPs where the product ranks #1

                • pos_11_100
                  Type: integer | null

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

                • pos_2_3
                  Type: integer | null

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

                • pos_4_10
                  Type: integer | null

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

                • search_volume
                  Type: integer | null Format: int64

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

              • amazon_serp
                Type: object | null · Response36Afe1097B20_AppMetricsInfo

                ranking data from Amazon organic SERP

                • count
                  Type: integer | null Format: int64

                  total count of Amazon organic SERPs that contain the product

                • pos_1
                  Type: integer | null

                  number of organic SERPs where the product ranks #1

                • pos_11_100
                  Type: integer | null

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

                • pos_2_3
                  Type: integer | null

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

                • pos_4_10
                  Type: integer | null

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

                • search_volume
                  Type: integer | null Format: int64

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

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

          • location_code
            Type: integer | null

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

          • 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_rank_overview/live
curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/amazon/product_rank_overview/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "asins": [
      "B001TJ3HUG",
      "B01LW2SL7R"
    ],
    "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,
          "location_code": null,
          "language_code": null,
          "total_count": null,
          "items_count": null,
          "items": [
            {
              "se_type": null,
              "asin": null,
              "metrics": "[Max Depth Exceeded]"
            }
          ]
        }
      ]
    }
  ]
}
Product Rank Overview

Need help?