v0.1.0-beta

OpenAPI 3.1.0

OnPage API Microdata

Felo API Support

MIT

Сервер

https://openapi.felo.ai

Клиентские библиотеки

Shell Curl

DataForSEO

SEO, search-engine results, keyword research, backlinks and AI visibility data.

DataForSEO Операции

post/v1/beta/dataforseo/on_page/microdata

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.

Тело

обязательно

application/json

Тип: array object[]
- id
  Тип: string
  обязательно
  
  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"
- url
  Тип: string
  обязательно
  
  resource URL required field you can get this URL in the response of the Pages endpoint example: https://dataforseo.com/apis
- tag
  Тип: string
  
  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

Ответы

200
Тип: object

Successful response
cost
Тип: number

total tasks cost, USD

status_code
Тип: integer

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_message
Тип: string

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

tasks
Тип: array string[]

array of tasks

tasks_count
Тип: integer

the number of tasks in the tasks array

tasks_error
Тип: integer

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

tasks.cost
Тип: number

cost of the task, USD

tasks.data
Тип: object

contains the same parameters that you specified in the POST request

tasks.id
Тип: string

task identifier unique task identifier in our system in the UUID format

tasks.path
Тип: array string[]

URL path

tasks.result
Тип: array string[]

array of results

tasks.result_count
Тип: integer

number of elements in the result array

tasks.result.crawl_progress
Тип: string

status of the crawling session possible values: in_progress, finished

tasks.result.crawl_status
Тип: object

details of the crawling session

tasks.result.crawl_status.max_crawl_pages
Тип: integer

maximum number of pages to crawl indicates the max_crawl_pages limit you specified when setting a task

tasks.result.crawl_status.pages_crawled
Тип: integer

number of crawled pages

tasks.result.crawl_status.pages_in_queue
Тип: integer

number of pages that are currently in the crawling queue

tasks.result.inspection_info
Тип: object

information related to microdata validation

tasks.result.inspection_info.fields
Тип: array string[]

microdata fields an array of objects containing data fields related to the certain microdata type

tasks.result.inspection_info.fields.fields
Тип: array string[]

microdata fields an array of objects containing data fields related to the certain microdata type

tasks.result.inspection_info.fields.name
Тип: string

field name name of the data field

tasks.result.inspection_info.fields.test_results
Тип: object

microdata validation test results sub-type microdata test results that contain detected errors and related messages

tasks.result.inspection_info.fields.test_results.level
Тип: string

level of microdata error can take the following values: fatal, error, warning, info

tasks.result.inspection_info.fields.test_results.message
Тип: string

message associated with an error message providing the details of the detected error

tasks.result.inspection_info.fields.types
Тип: array string[]

list of microdata sub-types

tasks.result.inspection_info.fields.value
Тип: array string[]

microdata value microdata value specified on a target web page

tasks.result.inspection_info.types
Тип: array string[]

parent microdata types for a full list of available types, please visit schema.org

tasks.result.items
Тип: array string[]

items array

tasks.result.items_count
Тип: integer

number of items in the results array

tasks.result.test_summary
Тип: object

microdata validation test results

tasks.result.test_summary.error
Тип: integer

number of serious microdata errors

tasks.result.test_summary.fatal
Тип: integer

number of fatal microdata errors

tasks.result.test_summary.info
Тип: integer

number of microdata information flags

tasks.result.test_summary.warning
Тип: integer

number of microdata warnings

tasks.result.type
Тип: string

type of the item = ‘json_ld’

tasks.status_code
Тип: integer

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

tasks.status_message
Тип: string

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

tasks.time
Тип: string

execution time, seconds

time
Тип: string

execution time, seconds

version
Тип: string

the current version of the API
application/json
400

Bad request
401

Unauthorized
402

The request cannot proceed because a billing requirement is not met.
403

The account is not permitted to perform this operation.
429

Rate limit exceeded
500

Internal server error
502

The service could not complete the request.
503

The API or billing service is temporarily unavailable.
504

The service timed out while processing the request.
default

The operation failed. Keep the response request ID when contacting Felo support.

post/v1/beta/dataforseo/on_page/microdata

curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/microdata \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "id": "",
    "url": "",
    "tag": ""
  }
]'

Показать схему

{
  "version": "string",
  "status_code": 1,
  "status_message": "string",
  "time": "string",
  "cost": 1,
  "tasks_count": 1,
  "tasks_error": 1,
  "tasks": [
    "string"
  ],
  "tasks.id": "string",
  "tasks.status_code": 1,
  "tasks.status_message": "string",
  "tasks.time": "string",
  "tasks.cost": 1,
  "tasks.result_count": 1,
  "tasks.path": [
    "string"
  ],
  "tasks.data": {},
  "tasks.result": [
    "string"
  ],
  "tasks.result.crawl_progress": "string",
  "tasks.result.crawl_status": {},
  "tasks.result.crawl_status.max_crawl_pages": 1,
  "tasks.result.crawl_status.pages_in_queue": 1,
  "tasks.result.crawl_status.pages_crawled": 1,
  "tasks.result.test_summary": {},
  "tasks.result.test_summary.fatal": 1,
  "tasks.result.test_summary.error": 1,
  "tasks.result.test_summary.warning": 1,
  "tasks.result.test_summary.info": 1,
  "tasks.result.items_count": 1,
  "tasks.result.items": [
    "string"
  ],
  "tasks.result.type": "string",
  "tasks.result.inspection_info": {},
  "tasks.result.inspection_info.types": [
    "string"
  ],
  "tasks.result.inspection_info.fields": [
    "string"
  ],
  "tasks.result.inspection_info.fields.name": "string",
  "tasks.result.inspection_info.fields.types": [
    "string"
  ],
  "tasks.result.inspection_info.fields.value": [
    "string"
  ],
  "tasks.result.inspection_info.fields.test_results": {},
  "tasks.result.inspection_info.fields.test_results.level": "string",
  "tasks.result.inspection_info.fields.test_results.message": "string",
  "tasks.result.inspection_info.fields.fields": [
    "string"
  ]
}

Successful response

OnPage API Microdata

АутентификацияRequired

DataForSEO

OnPage API Microdata