Data API / DataForSEO / On Page

OnPage API Microdata

Validates the structured data on one crawled url. 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 page must have been part of the crawl: asking for a URL that was not returns status_code 40406, Requested page was not submitted for crawling, inside an HTTP 200. Widen max_crawl_pages or set start_url on the submit call if the page you want is missing. 💰 Free upstream: querying a finished crawl costs nothing, only the crawl itself does.

Parameters

No path, query, or header parameters.

Request body

idstringRequired
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"
urlstringRequired
resource URL required field you can get this URL in the response of the Pages endpoint example: https://dataforseo.com/apis
tagstringOptional
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

Example request

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

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
max_crawl_pagesintegerOptional
maximum number of pages to crawl indicates the max_crawl_pages limit you specified when setting a task
pages_in_queueintegerOptional
number of pages that are currently in the crawling queue
pages_crawledintegerOptional
number of crawled pages
test_summaryobjectOptional
microdata validation test results
fatalintegerOptional
number of fatal microdata errors
errorintegerOptional
number of serious microdata errors
warningintegerOptional
number of microdata warnings
infointegerOptional
number of microdata information flags
items_countintegerOptional
number of items in the results array
itemsstring[]Optional
items array
typestringOptional
type of the item = ‘json_ld’
inspection_infoobjectOptional
information related to microdata validation
typesstring[]Optional
parent microdata types for a full list of available types, please visit schema.org
fieldsstring[]Optional
microdata fields an array of objects containing data fields related to the certain microdata type
namestringOptional
field name name of the data field
typesstring[]Optional
list of microdata sub-types
valuestring[]Optional
microdata value microdata value specified on a target web page
test_resultsobjectOptional
microdata validation test results sub-type microdata test results that contain detected errors and related messages
levelstringOptional
level of microdata error can take the following values: fatal, error, warning, info
messagestringOptional
message associated with an error message providing the details of the detected error
fieldsstring[]Optional
microdata fields an array of objects containing data fields related to the certain microdata type