NAVNavbar
Logo
cURL php NodeJS Python cSharp

Keyword Density

‌‌
This endpoint will provide you with keyword density and keyword frequency data for terms appearing on the specified website or web page. You can filter and sort the data that will be retrieved with this API call.

Note: to use this endpoint, make sure the calculate_keyword_density parameter in the Task Post request is set to true

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 get a result
$post_array[] = array(
   "id" => "09101923-1535-0216-0000-2389a8854b70",
   "url" => "https://dataforseo.com/",
   "keyword_length" => 2,
   "filters" =>  [
            "frequency",
            ">",
            5
        ]
);
try {
   // POST /v3/on_page/keyword_density
   // the full list of possible parameters is available in documentation
   $result = $client->post('/v3/on_page/keyword_density', $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.20210907",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.2239 sec.",
  "cost": 0,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "09101923-1535-0216-0000-2389a8854b70",
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.1548 sec.",
      "cost": 0,
      "result_count": 1,
      "path": [
        "v3",
        "on_page",
        "keyword_density"
      ],
      "data": {
        "api": "on_page",
        "function": "keyword_density",
        "url": "https://dataforseo.com/",
        "keyword_length": 2,
        "order_by": [
          "frequency,desc"
        ],
        "filters": [
          "frequency",
          ">",
          5
        ],
        "target": "dataforseo.com",
        "max_crawl_pages": 10,
        "calculate_keyword_density": true
      },
      "result": [
        {
          "crawl_progress": "finished",
          "crawl_status": {
            "max_crawl_pages": 10,
            "pages_in_queue": 0,
            "pages_crawled": 10
          },
          "total_items_count": 10,
          "items_count": 10,
          "items": [
            {
              "keyword": "read more",
              "frequency": 9,
              "density": 0.007569386038687973
            },
            {
              "keyword": "data api",
              "frequency": 8,
              "density": 0.00672834314550042
            },
            {
              "keyword": "we can",
              "frequency": 8,
              "density": 0.00672834314550042
            },
            {
              "keyword": "serp api",
              "frequency": 6,
              "density": 0.005046257359125316
            },
            {
              "keyword": "docs api",
              "frequency": 6,
              "density": 0.005046257359125316
            },
            {
              "keyword": "see success",
              "frequency": 6,
              "density": 0.005046257359125316
            },
            {
              "keyword": "seo software",
              "frequency": 6,
              "density": 0.005046257359125316
            },
            {
              "keyword": "analytics api",
              "frequency": 6,
              "density": 0.005046257359125316
            },
            {
              "keyword": "success story",
              "frequency": 6,
              "density": 0.005046257359125316
            },
            {
              "keyword": "google shopping",
              "frequency": 6,
              "density": 0.005046257359125316
            }
          ]
        }
      ]
    }
  ]
}

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.

Description of the fields for setting a task:

Field name Type Description
id string ID of the task
required field
you can get this ID in the response of the Task POST endpoint
example:
“07131248-1535-0216-1000-17384017ad04”
keyword_length integer number of words for a keyword
required field
possible values:
1, 2, 3, 4, 5
url string page URL
optional field
if you do not specify a page here, the results will be provided for the whole website
if you use this field, the API response will contain only keywords from the specified page
a page should be specified with absolute URL (including http:// or https://)
limit integer the maximum number of returned keywords
optional field
default value: 100
maximum value: 1000
filters array array of results filtering parameters
optional field
you can add several filters at once (8 filters maximum)
you should set a logical operator and, or between the conditions
the following operators are supported:
=, <>, in, not_in, like, not_like
you can use the % operator with like and not_like to match any string of zero or more characters
example:
["keyword","=","%seo%"]

[["keyword","=","%seo%"],
"and",
["frequency","<","6"]]

[["keyword","not_like","%seo%"],
"and",
[["frequency",">","6"],"or",["density",">","0.02"]]]

The full list of possible filters is available by this link.

order_by array results sorting rules
optional field
you can use the same values as in the filters array to sort the results
possible sorting types:
asc – results will be sorted in the ascending order
desc – results will be sorted in the descending order
you should use a comma to set up a sorting type
example:
["frequency,desc"]
note that you can set no more than three sorting rules in a single request
you should use a comma to separate several sorting rules
example:
["keyword,asc","frequency,desc"]
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
            crawl_progress string status of the crawling session
possible values: in_progress, finished
            crawl_status object details of the crawling session
               max_crawl_pages integer maximum number of pages to crawl
indicates the max_crawl_pages limit you specified when setting a task
               pages_in_queue integer number of pages that are currently in the crawling queue
               pages_crawled integer number of crawled pages
            total_items_count integer total number of relevant items
total number of keywords on the specified website or web page matching the set keyword_length and filters
            items_count integer number of items in the results array
            items array items array
                keyword string returned keyword
                frequency integer keyword frequency
number of times the keyword appears on the website (or webpage if you specified a url)
                density integer keyword density
calculated as a ratio of frequency to the total count of keywords with the set keyword_length on the web page or website

‌‌