NAVNavbar
Logo
php python csharp java

Get Search Volume Results by id

This endpoint will provide you with search volume data for the last month, search volume trend for the last year (that will let you estimate search volume dynamics), current cost-per-click and competition values for paid search.

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/';
try {
	// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
	$client = new RestClient($api_url, null, 'login', 'password');
} 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";
	exit();
}
try {
	$result = array();
	// #1 - using this method you can get a list of completed tasks
	// in addition to '{{low_se_type_under}}' you can also set other parameters
	// the full list of possible parameters is available in documentation
	// GET /v3/keywords_data/google/{{low_se_type_under}}/tasks_ready
	$tasks_ready = $client->get('/v3/keywords_data/google/{{low_se_type_under}}/tasks_ready');
	// you can find the full list of the response codes here https://docs.dataforseo.com/v3/appendix/errors
	if (isset($tasks_ready['status_code']) AND $tasks_ready['status_code'] === 20000) {
		foreach ($tasks_ready['tasks'] as $task) {
			if (isset($task['result'])) {
				foreach ($task['result'] as $task_ready) {
					// #2 - using this method you can get results of each completed task
					// GET /v3/keywords_data/google/{{low_se_type_under}}/task_get/$id
					if (isset($task_ready['endpoint'])) {
						$result[] = $client->get($task_ready['endpoint']);
					}
					// #3 - another way to get the task results by id
					// GET /v3/keywords_data/google/{{low_se_type_under}}/task_get/$id
					/*
					if (isset($task_ready['id'])) {
						$result[] = $client->get('/v3/keywords_data/google/{{low_se_type_under}}/task_get/' . $task_ready['id']);
					}
					*/
				}
			}
		}
	}
	print_r($result);
	// do something with 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.20200130",
    "status_code": 20000,
    "status_message": "Ok.",
    "time": "0 sec.",
    "cost": 0,
    "tasks_count": 1,
    "tasks_error": 0,
    "tasks": [
        {
            "id": "01302123-1535-0110-0000-ab5f88f0c134",
            "status_code": 20000,
            "status_message": "Ok.",
            "time": "0 sec.",
            "cost": 0,
            "result_count": 1,
            "path": [
                "v3",
                "keywords_data",
                "google",
                "search_volume",
                "task_get",
                "01302123-1535-0110-0000-ab5f88f0c134"
            ],
            "data": {
                "api": "keywords_data",
                "function": "search_volume",
                "se": "google",
                "location_name": "London,England,United Kingdom",
                "language_name": "English",
                "priority": 2,
                "keywords": [
                    "average page rpm adsense"
                ],
                "tag": "tag1"
            },
            "result": [
                {
                    "keyword": "average page rpm adsense",
                    "location_code": 1006886,
                    "language_code": "en",
                    "competition": 0,
                    "cpc": 0,
                    "search_volume": 10,
                    "categories": null,
                    "monthly_searches": [
                        {
                            "year": 2019,
                            "month": 12,
                            "search_volume": 0
                        },
                        {
                            "year": 2019,
                            "month": 11,
                            "search_volume": 10
                        },
                        {
                            "year": 2019,
                            "month": 10,
                            "search_volume": 0
                        },
                        {
                            "year": 2019,
                            "month": 9,
                            "search_volume": 0
                        },
                        {
                            "year": 2019,
                            "month": 8,
                            "search_volume": 0
                        },
                        {
                            "year": 2019,
                            "month": 7,
                            "search_volume": 0
                        },
                        {
                            "year": 2019,
                            "month": 6,
                            "search_volume": 0
                        },
                        {
                            "year": 2019,
                            "month": 5,
                            "search_volume": 0
                        },
                        {
                            "year": 2019,
                            "month": 4,
                            "search_volume": 0
                        },
                        {
                            "year": 2019,
                            "month": 3,
                            "search_volume": 0
                        },
                        {
                            "year": 2019,
                            "month": 2,
                            "search_volume": 0
                        },
                        {
                            "year": 2019,
                            "month": 1,
                            "search_volume": 0
                        }
                    ]
                }
            ]
        }
    ]
}

Description of the fields for sending a request:

Field name Type Description
id string task identifier
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time


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
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 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 array contains the same parameters that you specified in the POST request
        result array array of results
            keyword string keyword
keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)
            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
            competition float competition
represents the relative amount of competition associated with the given keyword in paid SERP only. This value is based on Google Ads data and can be between 0 and 1 (inclusive).
if there is no data the value is null
            cpc float cost-per-click
represents the average cost per click (USD) historically paid for the keyword.
if there is no data then the value is null
            search_volume integer monthly average search volume rate
represents either the (approximate) number of searches for the given keyword idea on google.com or google.com and partners, depending on the user’s targeting
if there is no data then the value is null
            categories array product and service categories
you can download the full list of possible categories
if there is no data then the value is null
            monthly_searches array monthly searches
represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations
if there is no data then the value is null
                year integer year
                month integer month
                search_volume integer monthly average search volume rate

‌‌