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