データ API / DataForSEO / On Page
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.
パラメータ
パス・クエリ・ヘッダーのパラメータはありません。
リクエストボディ
idstring必須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_lengthinteger必須number of words for a keyword required field possible values: 1, 2, 3, 4, 5
urlstring任意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://)
limitinteger任意the maximum number of returned keywords optional field default value: 100 maximum value: 1000
filtersarray任意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.
order_bystring[]任意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"]
tagstring任意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
リクエスト例
curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/on_page/keyword_density" \
-H "Authorization: Bearer $FELO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"id": "<string>",
"keyword_length": 0,
"url": "<string>",
"limit": 0,
"filters": "<string>",
"order_by": [
"<string>"
],
"tag": "<string>"
}'レスポンス
レスポンスのフィールド
versionstring任意the current version of the API
status_codeinteger任意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_messagestring任意general informational message you can find the full list of general informational messages here
timestring任意execution time, seconds
costnumber任意total tasks cost, USD
tasks_countinteger任意the number of tasks in the tasks array
tasks_errorinteger任意the number of tasks in the tasks array returned with an error
tasksstring[]任意array of tasks
idstring任意task identifier unique task identifier in our system in the UUID format
status_codeinteger任意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_messagestring任意informational message of the task you can find the full list of general informational messages here
timestring任意execution time, seconds
costnumber任意cost of the task, USD
result_countinteger任意number of elements in the result array
pathstring[]任意URL path
dataobject任意contains the same parameters that you specified in the POST request
resultstring[]任意array of results
crawl_progressstring任意status of the crawling session possible values: in_progress, finished
crawl_statusobject任意details of the crawling session
max_crawl_pagesinteger任意maximum number of pages to crawl indicates the max_crawl_pages limit you specified when setting a task
pages_in_queueinteger任意number of pages that are currently in the crawling queue
pages_crawledinteger任意number of crawled pages
total_items_countinteger任意total number of relevant items total number of keywords on the specified website or web page matching the set keyword_length and filters
items_countinteger任意number of items in the results array
itemsstring[]任意items array
keywordstring任意returned keyword
frequencyinteger任意keyword frequency number of times the keyword appears on the website (or webpage if you specified a url)
densityinteger任意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