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.

Parameters

No path, query, or header parameters.

Request body

urlstringRequired
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
idstringRequired
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_viewbooleanOptional
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

Example request

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
}'

Response

Response fields

versionstringOptional
the current version of the API
status_codeintegerOptional
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_messagestringOptional
general informational message you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
total tasks cost, USD
tasks_countintegerOptional
the number of tasks in the tasks array
tasks_errorintegerOptional
the number of tasks in the tasks array returned with an error
tasksstring[]Optional
array of tasks
idstringOptional
task identifier unique task identifier in our system in the UUID format
status_codeintegerOptional
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_messagestringOptional
informational message of the task you can find the full list of general informational messages here
timestringOptional
execution time, seconds
costnumberOptional
cost of the task, USD
result_countintegerOptional
number of elements in the result array
pathstring[]Optional
URL path
dataobjectOptional
contains the same parameters that you specified in the POST request
resultstring[]Optional
array of results
crawl_progressstringOptional
status of the crawling session possible values: in_progress, finished
crawl_statusobjectOptional
details of the crawling session
items_countintegerOptional
number of items in the results array
itemsstring[]Optional
items array
typestringOptional
type of the returned item = ‘сontent_parsing_element’
fetch_timestringOptional
date and time when the content was fethced example: "2022-11-01 10:02:52 +00:00"
status_codeintegerOptional
status code of the page
page_contentobjectOptional
parsed content of the page
headerobjectOptional
parsed content of the header
primary_contentstring[]Optional
primary content on the page you can find more information about content priority calculation in this help center article
textstringOptional
content text
urlstringOptional
page URL displayed in case the text is a link anchor
urlsstring[]Optional
contains other URLs and anchors found in the content element
urlstringOptional
other URL found in the content element
anchor_textstringOptional
text of the URL’s anchor
secondary_contentstring[]Optional
secondary content on the page you can find more information about content priority calculation in this help center article
textstringOptional
content text
urlstringOptional
page URL displayed in case the text is a link anchor
urlsstring[]Optional
contains other URLs and anchors found in the content element
urlstringOptional
other URL found in the content element
anchor_textstringOptional
text of the URL’s anchor
table_contentstring[]Optional
content of the table on the page
headerstring[]Optional
content of the header of the table
row_cellsstring[]Optional
content of the row cells of the header
textstringOptional
text in the row cell
urlsstring[]Optional
contains other URLs and anchors found in the cell
urlstringOptional
URL found in the cell
anchor_textstringOptional
text of the URL’s anchor
is_headerbooleanOptional
indicates if the text belongs to the header
bodystring[]Optional
content of the body of the table
row_cellsstring[]Optional
content of the row cells of the header
textstringOptional
text in the row cell
urlsstring[]Optional
contains other URLs and anchors found in the cell
urlstringOptional
URL found in the cell
anchor_textstringOptional
text of the URL’s anchor
is_headerbooleanOptional
indicates if the text belongs to the header
footerstring[]Optional
content of the footer of the table
row_cellsstring[]Optional
content of the row cells of the header
textstringOptional
text in the row cell
urlsstring[]Optional
contains other URLs and anchors found in the cell
urlstringOptional
URL found in the cell
anchor_textstringOptional
text of the URL’s anchor
is_headerbooleanOptional
indicates if the text belongs to the header
footerobjectOptional
parsed content of the footer
main_topicstring[]Optional
main topic on the page you can find more information about topic priority calculation in this help center article
h_titlestringOptional
meta title
main_titlestringOptional
main title of the block
authorstringOptional
content author name
languagestringOptional
content language
levelstringOptional
HTML level
primary_contentstring[]Optional
primary content on the page you can find more information about content priority calculation in this help center article
textstringOptional
content text
urlstringOptional
page URL displayed in case the text is a link anchor
urlsstring[]Optional
contains other URLs and anchors found in the content element
urlstringOptional
other URL found in the content element
anchor_textstringOptional
text of the URL’s anchor
secondary_contentstring[]Optional
secondary content on the page you can find more information about content priority calculation in this help center article
secondary_topicstring[]Optional
secondary topic on the page you can find more information about topic priority calculation in this help center article
h_titlestringOptional
meta title
main_titlestringOptional
main title of the block
authorstringOptional
content author name
languagestringOptional
content language
levelstringOptional
HTML level
primary_contentstring[]Optional
primary content on the page you can find more information about content priority calculation in this help center article
textstringOptional
content text
urlstringOptional
page URL displayed in case the text is a link anchor
urlsstring[]Optional
contains other URLs and anchors found in the content element
urlstringOptional
other URL found in the content element
anchor_textstringOptional
text of the URL’s anchor
secondary_contentstring[]Optional
secondary content on the page you can find more information about content priority calculation in this help center article
ratingsstring[]Optional
contains objects with rating information for the products displayed on the page
namestringOptional
rating name Note: this field is not used in this particular object, and its value is always set to null
rating_valueintegerOptional
the value of the rating
max_rating_valueintegerOptional
maximum value for the rating
rating_countintegerOptional
the amount of feedback
relative_ratingnumberOptional
relative rating can take values from 0 to 1
offersstring[]Optional
array of products displayed on the page contains objects with information on products displayed on the page
namestringOptional
name of the product
priceintegerOptional
price of the product
price_currencystringOptional
price currency
price_valid_untilintegerOptional
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[]Optional
array of comments displayed on the page contains objects with information on comments related to displayed products
ratingobjectOptional
product’s rating contains information about the rating a customer has given to the product
namestringOptional
rating name Note: this field is not used in this particular object, and its value is always null
rating_valueintegerOptional
the value of the rating
max_rating_valueintegerOptional
maximum value for the rating
rating_countintegerOptional
the amount of feedback Note: this field is not used in this particular object, and its value is always null
relative ratingnumberOptional
relative rating can take values from 0 to 1
titlestringOptional
title of the customer’s comment
publish_datestringOptional
date when the comment was published
authorstringOptional
author of the comment
primary_contentstring[]Optional
primary content on the page you can find more information about content priority calculation in this help center article
textstringOptional
text of the comment
urlstringOptional
displayed in case the text is a link anchor
urlsstring[]Optional
contains other URLs and anchors found in the content element
contactsobjectOptional
contact information contains contact information displayed on the page
telephonesstring[]Optional
array of telephone numbers
emailsstring[]Optional
array of emails
page_as_markdownstringOptional
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