NAVNavbar
Logo
cURL php NodeJS Python cSharp

Product Rank Overview


This endpoint will provide you with ranking data from organic and paid Amazon SERPs for the target products. The returned results are specific to the asins specified in a POST request. Learn more about ASIN in this help center article.

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
$client = new RestClient($api_url, null, 'login', 'password');

$post_array = array();
// simple way to set a task
$post_array[] = array(
   "asins" => [
      "B001TJ3HUG",
      "B01LW2SL7R"
   ],
   "language_name" => "English",
   "location_code" => 2840
);
try {
   // POST /v3/dataforseo_labs/amazon/product_rank_overview/live
   $result = $client->post('/v3/dataforseo_labs/amazon/product_rank_overview/live', $post_array);
   print_r($result);
   // do something with post result
} catch (RestClientException $e) {
   echo "\n";
   print "HTTP code: {$e->getHttpCode()}\n";
   print "Error code: {$e->getCode()}\n";
   print "Message: {$e->getMessage()}\n";
   print  $e->getTraceAsString();
   echo "\n";
}
$client = null;
?>

The above command returns JSON structured like this:

{
    "version": "0.1.20220216",
    "status_code": 20000,
    "status_message": "Ok.",
    "time": "0.1460 sec.",
    "cost": 0.0102,
    "tasks_count": 1,
    "tasks_error": 0,
    "tasks": [
        {
            "id": "02231504-2806-0378-0000-6dc93fd79797",
            "status_code": 20000,
            "status_message": "Ok.",
            "time": "0.0595 sec.",
            "cost": 0.0102,
            "result_count": 1,
            "path": [
                "v3",
                "dataforseo_labs",
                "amazon",
                "product_rank_overview",
                "live"
            ],
            "data": {
                "api": "dataforseo_labs",
                "function": "product_rank_overview",
                "se_type": "amazon",
                "language_name": "English",
                "location_code": 2840,
                "asins": [
                    "B001TJ3HUG",
                    "B01LW2SL7R"
                ]
            },
            "result": [
                {
                    "se_type": "amazon",
                    "location_code": 2840,
                    "language_code": "en",
                    "total_count": 1,
                    "items_count": 2,
                    "items": [
                        {
                            "se_type": "amazon",
                            "asin": "B01LW2SL7R",
                            "metrics": {
                                "amazon_serp": {
                                    "pos_1": 4,
                                    "pos_2_3": 9,
                                    "pos_4_10": 10,
                                    "pos_11_100": 29,
                                    "count": 52,
                                    "search_volume": 16900
                                },
                                "amazon_paid": {
                                    "pos_1": 0,
                                    "pos_2_3": 0,
                                    "pos_4_10": 0,
                                    "pos_11_100": 0,
                                    "count": 0,
                                    "search_volume": 0
                                }
                            }
                        },
                        {
                            "se_type": "amazon",
                            "asin": "B001TJ3HUG",
                            "metrics": {
                                "amazon_serp": {
                                    "pos_1": 23,
                                    "pos_2_3": 36,
                                    "pos_4_10": 137,
                                    "pos_11_100": 520,
                                    "count": 716,
                                    "search_volume": 192700
                                },
                                "amazon_paid": {
                                    "pos_1": 5,
                                    "pos_2_3": 12,
                                    "pos_4_10": 14,
                                    "pos_11_100": 0,
                                    "count": 31,
                                    "search_volume": 8700
                                }
                            }
                        }
                    ]
                }
            ]
        }
    ]
}

All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute.

Below you will find a detailed description of the fields you can use for setting a task.

Description of the fields for setting a task:

Field name Type Description
asins array 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
location_name 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 the
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:
United Kingdom
location_code 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 the
https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
example:
2840
language_name 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
language_code 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
tag 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

As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

Description of the fields in the results array:

Field name Type Description
version string the current version of the API
status_code 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 string general informational message
you can find the full list of general informational messages here
time string execution time, seconds
cost float total tasks cost, USD
tasks_count integer the number of tasks in the tasks array
tasks_error integer the number of tasks in the tasks array returned with an error
tasks array array of tasks
        id string task identifier
unique task identifier in our system in the UUID format
        status_code 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
        status_message string informational message of the task
you can find the full list of general informational messages here
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data object contains the same parameters that you specified in the POST request
        result array array of results
            se_type string search engine type
            location_code integer location code in a POST array
if there is no data, then the value is null
            language_code string language code in a POST array
if there is no data, then the value is null
            total_count integer total amount of results in our database relevant to your request
            items_count integer the number of results returned in the items array
            items array contains detected Amazon product competitors and related data
                  se_type string search engine type
                  asin string ASIN of the product
unique product identifier on Amazon;
for more information, refer to this help center guide
                  metrics object average keyword position of the product
                      amazon_serp object ranking data from Amazon organic SERP
                          pos_1 integer number of organic SERPs where the product ranks #1
                          pos_2_3 integer number of organic SERPs where the product ranks #2-3
                          pos_4_10 integer number of organic SERPs where the product ranks #4-10
                          pos_11_100 integer number of organic SERPs where the product ranks #11-100
                          count integer total count of Amazon organic SERPs that contain the product
                          search_volume integer total search volume of the product’s ranking keywords in organic SERP
                      amazon_paid object ranking data from Amazon paid SERP
                          pos_1 integer number of paid SERPs where the product ranks #1
                          pos_2_3 integer number of paid SERPs where the product ranks #2-3
                          pos_4_10 integer number of paid SERPs where the product ranks #4-10
                          pos_11_100 integer number of paid SERPs where the product ranks #11-100
                          count integer total count of Amazon paid SERPs that contain the product
                          search_volume integer total search volume of the product’s ranking keywords in paid SERP

‌‌