データ 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