OnPage

‌‌ This endpoint is designed to validate structured JSON-LD data and Microdata. Using this function you will obtain microdata available on the specified page of the target website and detailed results of its validation. To use this endpoint, set the validate_micromarkup parameter to true in the POST request to OnPage API.

post/v3/on_page/microdata

Request

  • Base URL: https://api.dataforseo.com
  • URL: https://api.dataforseo.com/v3/on_page/microdata
  • Auth: HTTP basic

Request body

idstring

<em>ID of the task</em><br><strong>required field</strong><br>you can get this ID in the response of the <a href="/v3/on_page/task_post/">Task POST</a> endpoint<br>example:<br><code>"07131248-1535-0216-1000-17384017ad04"</code>

urlstring

<em>resource URL</em><br><strong>required field</strong><br>you can get this URL in the response of the <a href="/v3/on_page/pages/">Pages</a> endpoint<br>example:<br><code>https://dataforseo.com/apis</code>

tagstring nullable

<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response

Example request

[
  {
    "id": "02241700-1535-0216-0000-034137259bc1",
    "url": "https://dataforseo.com/apis"
  }
]

Response

Successful operation

versionstring nullable

the current version of the API

status_codeinteger nullable

general status code you can find the full list of the response codes here

status_messagestring nullable

general informational message you can find the full list of general informational messages here

timestring nullable

total execution time, seconds

costnumber double nullable

total tasks cost, USD

tasks_countinteger nullable

the number of tasks in the tasks array

tasks_errorinteger nullable

the number of tasks in the tasks array returned with an error

Changes