Data API / DataForSEO / On Page

OnPage API Content Parsing

Parses one crawled url into structured content, with markdown_view for a markdown rendering. 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. The standalone twin post_dataforseo_on_page_content_parsing_live parses any URL without a crawl - prefer that unless the page is already part of one.

Параметры

Параметров пути, запроса и заголовков нет.

Тело запроса

urlstringОбязательный
URL of the content to parse required field URL of the page to parse example: https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api
idstringОбязательный
ID of the task required field you can get this ID in the response of the Task POST endpoint note: the enable_content_parsing parameter in the POST request must be set to true example: "07131248-1535-0216-1000-17384017ad04"
markdown_viewbooleanНеобязательный
return page content as markdown optional field if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response; default value: false

Пример запроса

curl -X POST "https://openapi.felo.ai/v1/beta/dataforseo/on_page/content_parsing" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "<string>",
  "id": "<string>",
  "markdown_view": false
}'

Ответ

Поля ответа

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
items_countintegerНеобязательный
number of items in the results array
itemsstring[]Необязательный
items array
typestringНеобязательный
type of the returned item = ‘сontent_parsing_element’
fetch_timestringНеобязательный
date and time when the content was fethced example: "2022-11-01 10:02:52 +00:00"
status_codeintegerНеобязательный
status code of the page
page_contentobjectНеобязательный
parsed content of the page
headerobjectНеобязательный
parsed content of the header
primary_contentstring[]Необязательный
primary content on the page you can find more information about content priority calculation in this help center article
textstringНеобязательный
content text
urlstringНеобязательный
page URL displayed in case the text is a link anchor
urlsstring[]Необязательный
contains other URLs and anchors found in the content element
urlstringНеобязательный
other URL found in the content element
anchor_textstringНеобязательный
text of the URL’s anchor
secondary_contentstring[]Необязательный
secondary content on the page you can find more information about content priority calculation in this help center article
textstringНеобязательный
content text
urlstringНеобязательный
page URL displayed in case the text is a link anchor
urlsstring[]Необязательный
contains other URLs and anchors found in the content element
urlstringНеобязательный
other URL found in the content element
anchor_textstringНеобязательный
text of the URL’s anchor
table_contentstring[]Необязательный
content of the table on the page
headerstring[]Необязательный
content of the header of the table
row_cellsstring[]Необязательный
content of the row cells of the header
textstringНеобязательный
text in the row cell
urlsstring[]Необязательный
contains other URLs and anchors found in the cell
urlstringНеобязательный
URL found in the cell
anchor_textstringНеобязательный
text of the URL’s anchor
is_headerbooleanНеобязательный
indicates if the text belongs to the header
bodystring[]Необязательный
content of the body of the table
row_cellsstring[]Необязательный
content of the row cells of the header
textstringНеобязательный
text in the row cell
urlsstring[]Необязательный
contains other URLs and anchors found in the cell
urlstringНеобязательный
URL found in the cell
anchor_textstringНеобязательный
text of the URL’s anchor
is_headerbooleanНеобязательный
indicates if the text belongs to the header
footerstring[]Необязательный
content of the footer of the table
row_cellsstring[]Необязательный
content of the row cells of the header
textstringНеобязательный
text in the row cell
urlsstring[]Необязательный
contains other URLs and anchors found in the cell
urlstringНеобязательный
URL found in the cell
anchor_textstringНеобязательный
text of the URL’s anchor
is_headerbooleanНеобязательный
indicates if the text belongs to the header
footerobjectНеобязательный
parsed content of the footer
main_topicstring[]Необязательный
main topic on the page you can find more information about topic priority calculation in this help center article
h_titlestringНеобязательный
meta title
main_titlestringНеобязательный
main title of the block
authorstringНеобязательный
content author name
languagestringНеобязательный
content language
levelstringНеобязательный
HTML level
primary_contentstring[]Необязательный
primary content on the page you can find more information about content priority calculation in this help center article
textstringНеобязательный
content text
urlstringНеобязательный
page URL displayed in case the text is a link anchor
urlsstring[]Необязательный
contains other URLs and anchors found in the content element
urlstringНеобязательный
other URL found in the content element
anchor_textstringНеобязательный
text of the URL’s anchor
secondary_contentstring[]Необязательный
secondary content on the page you can find more information about content priority calculation in this help center article
secondary_topicstring[]Необязательный
secondary topic on the page you can find more information about topic priority calculation in this help center article
h_titlestringНеобязательный
meta title
main_titlestringНеобязательный
main title of the block
authorstringНеобязательный
content author name
languagestringНеобязательный
content language
levelstringНеобязательный
HTML level
primary_contentstring[]Необязательный
primary content on the page you can find more information about content priority calculation in this help center article
textstringНеобязательный
content text
urlstringНеобязательный
page URL displayed in case the text is a link anchor
urlsstring[]Необязательный
contains other URLs and anchors found in the content element
urlstringНеобязательный
other URL found in the content element
anchor_textstringНеобязательный
text of the URL’s anchor
secondary_contentstring[]Необязательный
secondary content on the page you can find more information about content priority calculation in this help center article
ratingsstring[]Необязательный
contains objects with rating information for the products displayed on the page
namestringНеобязательный
rating name Note: this field is not used in this particular object, and its value is always set to null
rating_valueintegerНеобязательный
the value of the rating
max_rating_valueintegerНеобязательный
maximum value for the rating
rating_countintegerНеобязательный
the amount of feedback
relative_ratingnumberНеобязательный
relative rating can take values from 0 to 1
offersstring[]Необязательный
array of products displayed on the page contains objects with information on products displayed on the page
namestringНеобязательный
name of the product
priceintegerНеобязательный
price of the product
price_currencystringНеобязательный
price currency
price_valid_untilintegerНеобязательный
displays the date and time until which the price is valid in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: "2022-11-01 10:02:52 +00:00"
commentsstring[]Необязательный
array of comments displayed on the page contains objects with information on comments related to displayed products
ratingobjectНеобязательный
product’s rating contains information about the rating a customer has given to the product
namestringНеобязательный
rating name Note: this field is not used in this particular object, and its value is always null
rating_valueintegerНеобязательный
the value of the rating
max_rating_valueintegerНеобязательный
maximum value for the rating
rating_countintegerНеобязательный
the amount of feedback Note: this field is not used in this particular object, and its value is always null
relative ratingnumberНеобязательный
relative rating can take values from 0 to 1
titlestringНеобязательный
title of the customer’s comment
publish_datestringНеобязательный
date when the comment was published
authorstringНеобязательный
author of the comment
primary_contentstring[]Необязательный
primary content on the page you can find more information about content priority calculation in this help center article
textstringНеобязательный
text of the comment
urlstringНеобязательный
displayed in case the text is a link anchor
urlsstring[]Необязательный
contains other URLs and anchors found in the content element
contactsobjectНеобязательный
contact information contains contact information displayed on the page
telephonesstring[]Необязательный
array of telephone numbers
emailsstring[]Необязательный
array of emails
page_as_markdownstringНеобязательный
page content in the markdown format page content in the text-to-HTML markdown format specify markdown_view as true in the request to return the value