NAVNavbar
Logo
php python csharp java

Setting Live ‘Keywords For Site’ Tasks

This endpoint will provide you with a list of keywords relevant to the specified domain along with their categories, search volume for the last month, search volume trend for the last year (for estimating search volume dynamics), current cost-per-click and competition values for paid search.

If your system requires delivering instant results, the Live method is the best solution for you. Unlike the Standard method, this method doesn’t require making separate POST and GET requests to the corresponding endpoints.

If you don’t need to receive data in real-time, you can use the Standard method of data retrieval. This method requires making separate POST and GET requests, but it’s more affordable. Using this method you can retrieve the results after our system collects them.

You can also check the update status of keywords search volume returned by Google API using the Get AdWords Status endpoint.

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();
}
$post_array = array();
// simple way to set a task
$post_array[] = array(
	"location_name" => "United States",
	"language_name" => "English",
	"target" => "dataforseo.com"
);
try {
	// POST /v3/keywords_data/google/keywords_for_site/live
	// the full list of possible parameters is available in documentation
	$result = $client->post('/v3/keywords_data/google/keywords_for_site/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.20200130",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.1233 sec.",
  "cost": 0.075,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "11201121-0696-0110-0000-36957f01d3e8",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.0033 sec.",
      "cost": 0.075,
      "result_count": 3,
      "path": [
        "v3",
        "keywords_data",
        "google",
        "keywords_for_site",
        "live"
      ],
      "data": {
        "api": "keywords_data",
        "function": "keywords_for_site",
        "se": "google",
        "location_name": "United States",
        "language_name": "English",
        "target": "dataforseo.com"
      },
      "result": [
        {
          "keyword": "leads and prospects",
          "location_code": 2840,
          "language_code": "en",
          "competition": 0.21775312066574204,
          "cpc": 2.817601,
          "search_volume": 70,
          "categories": [
            10004,
            10007,
            10012,
            10019,
            10102,
            10168,
            10276,
            10296,
            10885,
            11088,
            11273,
            12209,
            12376,
            13418
          ],
          "monthly_searches": [
            {
              "year": 2019,
              "month": 10,
              "search_volume": 110
            },
            {
              "year": 2019,
              "month": 9,
              "search_volume": 90
            },
            {
              "year": 2019,
              "month": 8,
              "search_volume": 70
            },
            {
              "year": 2019,
              "month": 7,
              "search_volume": 70
            },
            {
              "year": 2019,
              "month": 6,
              "search_volume": 70
            },
            {
              "year": 2019,
              "month": 5,
              "search_volume": 50
            },
            {
              "year": 2019,
              "month": 4,
              "search_volume": 110
            },
            {
              "year": 2019,
              "month": 3,
              "search_volume": 70
            },
            {
              "year": 2019,
              "month": 2,
              "search_volume": 90
            },
            {
              "year": 2019,
              "month": 1,
              "search_volume": 90
            },
            {
              "year": 2018,
              "month": 12,
              "search_volume": 40
            },
            {
              "year": 2018,
              "month": 11,
              "search_volume": 50
            }
          ]
        },
        {
          "keyword": "average page rpm adsense",
          "location_code": 2840,
          "language_code": "en",
          "competition": 0.10714285714285714,
          "cpc": 14.81844,
          "search_volume": 10,
          "categories": null,
          "monthly_searches": [
            {
              "year": 2019,
              "month": 10,
              "search_volume": 10
            },
            {
              "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
            },
            {
              "year": 2018,
              "month": 12,
              "search_volume": 0
            },
            {
              "year": 2018,
              "month": 11,
              "search_volume": 0
            }
          ]
        },
        {
          "keyword": "adsense blank ads how long",
          "location_code": 2840,
          "language_code": "en",
          "competition": 0.047619047619047616,
          "cpc": 0,
          "search_volume": 10,
          "categories": null,
          "monthly_searches": [
            {
              "year": 2019,
              "month": 10,
              "search_volume": 10
            },
            {
              "year": 2019,
              "month": 9,
              "search_volume": 0
            },
            {
              "year": 2019,
              "month": 8,
              "search_volume": 10
            },
            {
              "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": 10
            },
            {
              "year": 2019,
              "month": 3,
              "search_volume": 10
            },
            {
              "year": 2019,
              "month": 2,
              "search_volume": 10
            },
            {
              "year": 2019,
              "month": 1,
              "search_volume": 10
            },
            {
              "year": 2018,
              "month": 12,
              "search_volume": 10
            },
            {
              "year": 2018,
              "month": 11,
              "search_volume": 10
            }
          ]
        }
      ]
    }
  ]
}

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.

You can get up to 700 keyword suggestions with all essential keyword data in response to one request. Your account will be charged for each request, no matter what number of keywords you receive in the result, the price for 1 or 700 keywords will be the same.

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
target string domain
required field
the domain name of the target website
location_name string full name of search engine location
optional field
if you use this field, you don’t need to specify location_code or location_coordinate
you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/keywords_data/google/locations
ignore this field to receive global results
example:
London,England,United Kingdom
location_code integer search engine location code
optional field
if you use this field, you don’t need to specify location_name or location_coordinate
you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/google/locations
ignore this field to receive global results
example:
2840
location_coordinate string GPS coordinates of a location
optional field
if you use this field, you don’t need to specify location_name or location_code
location_coordinate parameter should be specified in the “latitude,longitude” format
the data will be provided for the country the specified coordinates belong to
ignore this field to receive global results
example:
52.6178549,-155.352142
language_name string full name of search engine language
optional field if you specify language_code
if you use this field, you don’t need to specify language_code
you can receive the list of available locations of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/keywords_data/google/languages
example:
English
language_code string search engine language code
optional field if you specify language_name
if you use this field, you don’t need to specify language_name
you can receive the list of available locations of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/keywords_data/google/languages
example:
en
sort_by string results sorting parameters
optional field
Use these parameters to sort the results by search_volume or relevance in the descending order
default value: search_volume
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 array 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
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 that were returned 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, then 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 the (approximate) number of searches for the keyword 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 (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

‌‌