Felo API PlatformFelo API Platform
v0.1.0-beta
OpenAPI 3.1.0

Keyword Density

Felo API Support
MIT
Server:https://openapi.felo.ai
Client Libraries
Shell Curl

DataForSEO

​

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Operations

Keyword Density

​

Word and phrase frequency across a crawl, with keyword_length choosing n-gram size. Returns total_items_count, items_count and items. Reads a finished crawl, so it needs the id from post_dataforseo_on_page_submit and returns crawl_progress plus a crawl_status of max_crawl_pages, pages_in_queue and pages_crawled - check those before trusting a small result, because a crawl still running simply has less to report. This describes what a site says about itself; for what the web says about it use post_dataforseo_backlinks_anchors_live, and for what people search use post_dataforseo_keywords_gads_search_volume_live. 💰 Free upstream: querying a finished crawl costs nothing, only the crawl itself does.

Body
required
application/json
  • Type: array object[]
    • id
      Type: string
      required

      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
      Type: integer
      required

      number of words for a keyword required field possible values: 1, 2, 3, 4, 5

    • filters
      Type: 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: regex, not_regex, =, , 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"," [["keyword","not_like","%seo%"], "and", [["frequency",">","6"],"or",["density",">","0.02"]]] The full list of possible filters is available by this link.

    • limit
      Type: integer

      the maximum number of returned keywords optional field default value: 100 maximum value: 1000

    • order_by
      Type: array string[]

      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
      Type: 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

    • url
      Type: 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://)

Responses
  • 200
    Type: object

    Successful response

    • cost
      Type: number

      total tasks cost, USD

    • status_code
      Type: 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
      Type: string

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

    • tasks
      Type: array string[]

      array of tasks

    • tasks_count
      Type: integer

      the number of tasks in the tasks array

    • tasks_error
      Type: integer

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

    • tasks.cost
      Type: number

      cost of the task, USD

    • tasks.data
      Type: object

      contains the same parameters that you specified in the POST request

    • tasks.id
      Type: string

      task identifier unique task identifier in our system in the UUID format

    • tasks.path
      Type: array string[]

      URL path

    • tasks.result
      Type: array string[]

      array of results

    • tasks.result_count
      Type: integer

      number of elements in the result array

    • tasks.result.crawl_progress
      Type: string

      status of the crawling session possible values: in_progress, finished

    • tasks.result.crawl_status
      Type: object

      details of the crawling session

    • tasks.result.crawl_status.max_crawl_pages
      Type: integer

      maximum number of pages to crawl indicates the max_crawl_pages limit you specified when setting a task

    • tasks.result.crawl_status.pages_crawled
      Type: integer

      number of crawled pages

    • tasks.result.crawl_status.pages_in_queue
      Type: integer

      number of pages that are currently in the crawling queue

    • tasks.result.items
      Type: array string[]

      items array

    • tasks.result.items_count
      Type: integer

      number of items in the results array

    • tasks.result.items.density
      Type: 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

    • tasks.result.items.frequency
      Type: integer

      keyword frequency number of times the keyword appears on the website (or webpage if you specified a url)

    • tasks.result.items.keyword
      Type: string

      returned keyword

    • tasks.result.total_items_count
      Type: integer

      total number of relevant items total number of keywords on the specified website or web page matching the set keyword_length and filters

    • tasks.status_code
      Type: 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

    • tasks.status_message
      Type: string

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

    • tasks.time
      Type: string

      execution time, seconds

    • time
      Type: string

      execution time, seconds

    • version
      Type: string

      the current version of the API

    application/json
  • 400

    Bad request

  • 401

    Unauthorized

  • 402

    The request cannot proceed because a billing requirement is not met.

  • 403

    The account is not permitted to perform this operation.

  • 429

    Rate limit exceeded

  • 500

    Internal server error

  • 502

    The service could not complete the request.

  • 503

    The API or billing service is temporarily unavailable.

  • 504

    The service timed out while processing the request.

  • default

    The operation failed. Keep the response request ID when contacting Felo support.

Request Example for post/v1/beta/dataforseo/on_page/keyword_density
curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/keyword_density \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "id": "",
    "keyword_length": 1,
    "url": "",
    "limit": 1,
    "filters": [],
    "order_by": [
      ""
    ],
    "tag": ""
  }
]'

{
  "version": "string",
  "status_code": 1,
  "status_message": "string",
  "time": "string",
  "cost": 1,
  "tasks_count": 1,
  "tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": {},
  "tasks.result": [
    "string"
  ],
  "tasks.result.crawl_progress": "string",
  "tasks.result.crawl_status": {},
  "tasks.result.crawl_status.max_crawl_pages": 1,
  "tasks.result.crawl_status.pages_in_queue": 1,
  "tasks.result.crawl_status.pages_crawled": 1,
  "tasks.result.total_items_count": 1,
  "tasks.result.items_count": 1,
  "tasks.result.items": [
    "string"
  ],
  "tasks.result.items.keyword": "string",
  "tasks.result.items.frequency": 1,
  "tasks.result.items.density": 1
}

Successful response

Keyword Density