NAVNavbar
Logo
php python csharp java

Get ‘Ads Traffic By Keywords’ Results by id


You can receive a set of stats for daily impressions, CPC and clicks estimation. This data is really useful for estimating real demand for a specific keyword, as it is much more accurate than the regular search volume information, which shows the broad match estimation for a group of similar keywords.

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
	// 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": "3.20191128",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "1.5868 sec.",
  "cost": 0,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "11211007-0696-0094-0000-b5b4b12c78bb",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "1.5131 sec.",
      "cost": 0,
      "result_count": 1,
      "path": [
        "v3",
        "keywords_data",
        "google",
        "ad_traffic_by_keywords",
        "task_get"
      ],
      "data": {
        "api": "keywords_data",
        "function": "ad_traffic_by_keywords",    
        "se": "google",
        "language_code": "en",
        "location_code": 2840,
        "bid": 999,
        "match": "exact",
        "keywords": [
          "seo marketing"
        ],
        "tag": "tag1"
      },
      "result": [
        {
          "language_code": "en",
          "location_code": 2840,
          "bid": 999,
          "keyword": "seo marketing",
          "match": "exact",
          "ad_position_min": 1.11,
          "ad_position_max": 1,
          "ad_position_average": 1.06,
          "cpc_min": 38.86,
          "cpc_max": 47.5,
          "cpc_average": 43.18,
          "daily_impressions_min": 140.29,
          "daily_impressions_max": 171.47,
          "daily_impressions_average": 155.88,
          "daily_clicks_min": 1.14,
          "daily_clicks_max": 1.39,
          "daily_clicks_average": 1.27,
          "daily_cost_min": 49.2,
          "daily_cost_max": 60.13,
          "daily_cost_average": 54.67
        }
      ]
    }
  ]
}

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 result 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
            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
            bid float the maximum custom bid
the bid you have specified when setting the task
represents the price you are willing to pay for an ad
the higher value you have specified, the higher positions and price you receive in response
            keyword string keyword
keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character)
            match string keywords match-type
can take the following values: exact, broad, phrase
            ad_position_min float the minimum ad position
represents the minimum position of the advertisement
if there is no data, then the value is null
            ad_position_max float the maximum ad position
represents the maximum position of the advertisement
if there is no data, then the value is null
            ad_position_average float the average ad position
represents the average position of the advertisement
if there is no data, then the value is null
            cpc_min float the minimum value of cost-per-click
represents the minimum cost-per-click (USD) historically paid for the keyword
if there is no data, then the value is null
            cpc_max float the maximum value of cost-per-click
represents the maximum cost-per-click (USD) historically paid for the keyword
if there is no data, then the value is null
            cpc_average float the average value of 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
            daily_impressions_min float the minimum value of daily impressions
represents the minimum number of daily impressions of the advertisement
if there is no data, then the value is null
            daily_impressions_max float the maximum value of daily impressions
represents the maximum number of daily impressions of the advertisement
if there is no data, then the value is null
            daily_impressions_average float the average value of daily impressions
represents the average number number of daily impressions of the advertisement
if there is no data, then the value is null
            daily_clicks_min float the minimum value of daily clicks
represents the minimum number of daily clicks on the advertisement
if there is no data, then the value is null
            daily_clicks_max float the maximum value of daily clicks
represents the maximum number of daily clicks on the advertisement
if there is no data, then the value is null
            daily_clicks_average float the average value of daily clicks
represents the average number of daily clicks on the advertisement
if there is no data, then the value is null
            daily_cost_min float the minimum daily charge value
represents the minimum daily charge for the advertisement
if there is no data, then the value is null
            daily_cost_max float the maximum daily charge value
represents the maximum daily charge for the advertisement
if there is no data, then the value is null
            daily_cost_average float the average daily charge value
represents the average daily charge for the advertisement
if there is no data, then the value is null

‌‌