# Product Rank Overview

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/dataforseo_labs/amazon/product_rank_overview/live`

**Tags:** DataForSEO

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.

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "asins": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "<em>product IDs to compare</em><br><strong>required field</strong><br>product IDs to receive ranking data for;<br><strong>the maximum number of ASINs you can specify in this array is 1000;</strong><br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a><p><strong>Note:</strong> all letters in ASIN code must be specified in uppercase format;<br>example:<br><code>B01LW2SL7R</code>"
          },
          "location_name": {
            "type": "string",
            "description": "<em>full name of the location</em><br><strong>required field if don't specify <code>location_code</code></strong><br>you can receive the list of available locations with their <code>location_name</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">United States</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>location code</em><br><strong>required field if don't specify <code>location_name</code></strong><br>you can receive the list of available locations with their <code>location_code</code> by making a separate request to <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code>;<br><strong>Note:</strong> this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only;<br>example:<br><code class=\"long-string\">2840</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>full name of the language</em><br><strong>required field if don't specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">English</code>"
          },
          "language_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>language code</em><br><strong>required field if don't specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code> by making a separate request to the <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code><br>example:<br><code class=\"long-string\">en</code>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response"
          }
        },
        "example": [
          {
            "asins": [
              "B001TJ3HUG",
              "B01LW2SL7R"
            ],
            "language_name": "English",
            "location_code": 2840
          }
        ]
      }
    ]
  },
  "example": [
    {
      "asins": [
        "B001TJ3HUG",
        "B01LW2SL7R"
      ],
      "language_name": "English",
      "location_code": 2840
    }
  ]
}
```

## Responses

### 200 — Successful operation

Headers:
- `X-Request-Id` (string) — Request identifier to include when contacting Felo support.

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonProductRankOverviewLiveResponseInfo"
    }
  ]
}
```

### 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**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_AmazonMetricsBundleInfo

`#/components/schemas/Response36Afe1097B20_AmazonMetricsBundleInfo`

```json
{
  "type": "object",
  "properties": {
    "amazon_serp": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_AppMetricsInfo"
        }
      ],
      "description": "<em>ranking data from Amazon organic SERP</em>"
    },
    "amazon_paid": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_AppMetricsInfo"
        }
      ],
      "description": "<em>ranking data from Amazon paid SERP</em>"
    }
  }
}
```

### Response36Afe1097B20_AppMetricsInfo

`#/components/schemas/Response36Afe1097B20_AppMetricsInfo`

```json
{
  "type": "object",
  "properties": {
    "pos_1": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>number of organic SERPs where the product ranks #1</em>"
    },
    "pos_2_3": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>number of organic SERPs where the product ranks #2-3</em>"
    },
    "pos_4_10": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>number of organic SERPs where the product ranks #4-10</em>"
    },
    "pos_11_100": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>number of organic SERPs where the product ranks #11-100</em>"
    },
    "count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>total count of Amazon organic SERPs that contain the product</em>",
      "format": "int64"
    },
    "search_volume": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>total search volume of the product's ranking keywords in organic SERP</em>",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "the current version of the API"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "general status code\nyou can find the full list of the response codes here"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "general informational message\nyou can find the full list of general informational messages here"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "total execution time, seconds"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "total tasks cost, USD",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "the number of tasks in the tasks array",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "the number of tasks in the tasks array returned with an error",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "task identifier\nunique task identifier in our system in the UUID format"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "status code of the task\ngenerated by DataForSEO, can be within the following range: 10000-60000\nyou can find the full list of the response codes here"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "informational message of the task\nyou can find the full list of general informational messages here"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "execution time, seconds"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "total tasks cost, USD",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "number of elements in the result array",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "URL path"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "contains the same parameters that you specified in the POST request"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsAmazonProductRankOverviewLiveItem

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonProductRankOverviewLiveItem`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>search engine type</em>"
    },
    "asin": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>ASIN of the product</em><br>unique product identifier on Amazon;<br>for more information, refer to <a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>"
    },
    "metrics": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_AmazonMetricsBundleInfo"
        }
      ],
      "description": "<em>average keyword position of the product</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsAmazonProductRankOverviewLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonProductRankOverviewLiveResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonProductRankOverviewLiveTaskInfo"
              }
            ]
          },
          "description": "<em>array of tasks</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_DataforseoLabsAmazonProductRankOverviewLiveResultInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonProductRankOverviewLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>search engine type</em>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>location code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>language code in a POST array</em><br>if there is no data, then the value is_<code>null</code>n"
    },
    "total_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>total amount of results in our database relevant to your request</em>",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>the number of results returned in the <code>items</code> array</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonProductRankOverviewLiveItem"
          }
        ]
      },
      "description": "<em>contains detected Amazon product competitors and related data</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsAmazonProductRankOverviewLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonProductRankOverviewLiveTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsAmazonProductRankOverviewLiveResultInfo"
              }
            ]
          },
          "description": "<em>array of results</em>"
        }
      }
    }
  ]
}
```