NAVNavbar
Logo
cURL php NodeJS Python cSharp

Bulk Traffic Estimation (Legacy)

‌‌‌

Note that the structure of DataForSEO Labs API requests and responses was updated on 2022-03-19. However, we will continue supporting the legacy version documented here. You can review the documentation of the new version by this link.

 
This endpoint will provide you with estimated monthly traffic volumes for up to 1,000 domains. Along with organic search traffic estimations, you will also get separate values for paid search, featured snippet, and local pack results.

Traffic volume is calculated as the product of CTR (click-through rate) and search volume values of all keywords the domain ranks for in a relevant category of search results (organic, paid, featured snippet, or local pack). You can learn more about how we calculate this metric in this help center article.

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

<?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-access
$client = new RestClient($api_url, null, 'login', 'password');

$post_array = array();
// simple way to set a task
$post_array[] = array(
   "targets" => [
      "dataforseo.com",
      "cnn.com",
      "forbes.com"
   ],
   "language_name" => "English",
   "location_code" => 2840,
   "item_types" => [
      "organic",
      "paid"
   ]
);
try {
   // POST /v3/dataforseo_labs/bulk_traffic_estimation/live
   $result = $client->post('/v3/dataforseo_labs/bulk_traffic_estimation/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.20210917",
    "status_code": 20000,
    "status_message": "Ok.",
    "time": "0.2930 sec.",
    "cost": 0.0103,
    "tasks_count": 1,
    "tasks_error": 0,
    "tasks": [
        {
            "id": "11261921-1535-0365-0000-33f1d9943d3e",
            "status_code": 20000,
            "status_message": "Ok.",
            "time": "0.2426 sec.",
            "cost": 0.0103,
            "result_count": 1,
            "path": [
                "v3",
                "dataforseo_labs",
                "bulk_traffic_estimation",
                "live"
            ],
            "data": {
                "api": "dataforseo_labs",
                "function": "bulk_traffic_estimation",
                "targets": [
                    "dataforseo.com",
                    "cnn.com",
                    "forbes.com"
                ],
                "location_code": 2840,
                "language_code": "en",
                "item_types": [
                    "organic",
                    "paid"
                ]
            },
            "result": [
                {
                    "location_code": 2840,
                    "language_code": "en",
                    "total_count": 3,
                    "items_count": 3,
                    "items": [
                        {
                            "target": "cnn.com",
                            "metrics": {
                                "organic": {
                                    "etv": 217332878.18734226,
                                    "count": 11786473
                                },
                                "paid": {
                                    "etv": 0,
                                    "count": 0
                                },
                                "local_pack": null,
                                "featured_snippet": null
                            }
                        },
                        {
                            "target": "forbes.com",
                            "metrics": {
                                "organic": {
                                    "etv": 187885962.6140026,
                                    "count": 16242380
                                },
                                "paid": {
                                    "etv": 7245.073922678828,
                                    "count": 499
                                },
                                "local_pack": null,
                                "featured_snippet": null
                            }
                        },
                        {
                            "target": "dataforseo.com",
                            "metrics": {
                                "organic": {
                                    "etv": 3511.982047529891,
                                    "count": 1708
                                },
                                "paid": {
                                    "etv": 6.360000163316727,
                                    "count": 6
                                },
                                "local_pack": null,
                                "featured_snippet": null
                            }
                        }
                    ]
                }
            ]
        }
    ]
}

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
targets array target domains
required field
domain names of the target websites
each domain should be specified without https:// and www.
you can set up to 1000 domains in this array
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
item_types array display results by item type
optional field
indicates the type of search results included in the response

Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array

possible values:
["organic", "paid", "featured_snippet", "local_pack"]
default value:
["organic", "paid"]

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
            target string target domain in a POST array
            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
            metrics object traffic data relevant to the specified domain
                organic object traffic data from organic search
                    etv float estimated traffic volume
estimated organic monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for
learn more about how the metric is calculated in this help center article
                    count integer total count of organic SERPs that contain the domain
                paid object traffic data from paid search
                    etv float estimated traffic volume
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain ranks for
learn more about how the metric is calculated in this help center article
                    count integer total count of paid SERPs that contain the domain
                featured_snippet object traffic data from the featured snippet results in Google SERP
                    etv float estimated traffic volume
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
                    count integer total count of featured snippet items that contain the domain
                local_pack object traffic data from the local pack results in SERP
                    etv float estimated traffic volume
estimated paid monthly traffic to the domain
calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the domain ranks for
learn more about how the metric is calculated in this help center article
                    count integer total count of local pack items that contain the domain

‌‌