資料 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.

參數

沒有路徑、查詢或請求標頭參數。

請求主體

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"
urlstring必填
resource URL required field you can get this URL in the response of the Pages endpoint example: https://dataforseo.com/apis
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/microdata" \
  -H "Authorization: Bearer $FELO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "<string>",
  "url": "<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
test_summaryobject選填
microdata validation test results
fatalinteger選填
number of fatal microdata errors
errorinteger選填
number of serious microdata errors
warninginteger選填
number of microdata warnings
infointeger選填
number of microdata information flags
items_countinteger選填
number of items in the results array
itemsstring[]選填
items array
typestring選填
type of the item = ‘json_ld’
inspection_infoobject選填
information related to microdata validation
typesstring[]選填
parent microdata types for a full list of available types, please visit schema.org
fieldsstring[]選填
microdata fields an array of objects containing data fields related to the certain microdata type
namestring選填
field name name of the data field
typesstring[]選填
list of microdata sub-types
valuestring[]選填
microdata value microdata value specified on a target web page
test_resultsobject選填
microdata validation test results sub-type microdata test results that contain detected errors and related messages
levelstring選填
level of microdata error can take the following values: fatal, error, warning, info
messagestring選填
message associated with an error message providing the details of the detected error
fieldsstring[]選填
microdata fields an array of objects containing data fields related to the certain microdata type