Sign in
OnPage

Changed on

‌‌ 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.

post/v3/on_page/keyword_density

Request

  • Base URL: https://api.dataforseo.com
  • URL: https://api.dataforseo.com/v3/on_page/keyword_density
  • Auth: HTTP basic

Request body

idstring

<em>ID of the task</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="/v3/on_page/task_post/">Task POST</a> endpoint<br>example:<br>"07131248-1535-0216-1000-17384017ad04"

keyword_lengthinteger

<em>number of words for a keyword</em><br><strong>required field</strong><br>possible values:<br><code>1</code>, <code>2</code>, <code>3</code>, <code>4</code>, <code>5</code>

urlstring nullable

<em>page URL</em><br>optional field<br><strong>if you do not specify a page here, the results will be provided for the whole website</strong><br>if you use this field, the API response will contain only keywords from the specified page<br>a page should be specified with absolute URL (including <code>http://</code> or <code>https://</code>)

limitinteger nullable

<em>the maximum number of returned keywords</em><br>optional field<br>default value: <code>100</code><br>maximum value: <code>1000</code>

filtersobject[] nullable

<em>array of results filtering parameters</em><br>optional field<br><strong>you can add several filters at once (8 filters maximum)</strong><br>you should set a logical operator <code>and</code>, <code>or</code> between the conditions<br>the following operators are supported:<br><code>regex</code>, <code>not_regex</code>, <code>=</code>, <code><></code>, <code>in</code>, <code>not_in</code>, <code>like</code>, <code>not_like</code><br>you can use the <code>%</code> operator with <code>like</code> and <code>not_like</code> to match any string of zero or more characters<br>example:<br><code>["keyword","=","%seo%"]</code><p><code>[["keyword","=","%seo%"],<br>"and",<br>["frequency","<","6"]]</code><p><code>[["keyword","not_like","%seo%"],<br>"and",<br>[["frequency",">","6"],"or",["density",">","0.02"]]]</code><p>The full list of possible filters is available <a href="/v3/on_page/filters_and_thresholds/?bash" target="_blank" rel="noopener noreferrer">by this link.</a>

order_bystring[] nullable

<em>results sorting rules</em><br>optional field<br>you can use the same values as in the <code>filters</code> array to sort the results<br>possible sorting types:<br><code>asc</code> - results will be sorted in the ascending order<br><code>desc</code> - results will be sorted in the descending order<br>you should use a comma to set up a sorting type<br>example:<br><code>["frequency,desc"]</code><br><strong>note that you can set no more than three sorting rules in a single request</strong><br>you should use a comma to separate several sorting rules<br>example:<br><code>["keyword,asc","frequency,desc"]</code>

tagstring nullable

<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response

Example request

[
  {
    "id": "09101923-1535-0216-0000-2389a8854b70",
    "url": "https://dataforseo.com/",
    "keyword_length": 2,
    "filters": [
      "frequency",
      ">",
      5
    ]
  }
]

Response

Successful operation

versionstring nullable

the current version of the API

status_codeinteger nullable

general status code you can find the full list of the response codes here

status_messagestring nullable

general informational message you can find the full list of general informational messages here

timestring nullable

total execution time, seconds

costnumber double nullable

total tasks cost, USD

tasks_countinteger nullable

the number of tasks in the tasks array

tasks_errorinteger nullable

the number of tasks in the tasks array returned with an error

Changes