# OnPage API 微数据

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/on_page/microdata`

**Tags:** DataForSEO

校验某个已爬取 `url` 上的结构化数据。读取已完成的爬取，因此需要 `post_dataforseo_on_page_submit` 返回的 `id`，并返回 `crawl_progress` 以及 `crawl_status`（`max_crawl_pages`、`pages_in_queue` 和 `pages_crawled`）——在采信偏少的结果前先检查这些字段，因为仍在进行的爬取能报告的内容本来就少。⚠️ 该页面必须属于本次爬取：请求一个不属于爬取的 URL 会在 HTTP 200 内返回 `status_code` 40406、`Requested page was not submitted for crawling`。如果要找的页面缺失，请调大 `max_crawl_pages`，或在提交调用中设置 `start_url`。💰 上游免费：查询已完成的爬取不产生费用，只有爬取本身计费。

### 计费参考

- 计量方式：按上报的响应成本计量。
- 参考请求估算：0.012 美元。
- 参考客户倍率：1.0。不得对已结算的客户金额再次应用。

仅供参考的元数据，不是账户报价、保证价格或消费上限。资源额度不同于 Felo 额度。最终扣费以 Felo 计费记录为准。

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "<em>任务 ID</em><br><strong>必填字段</strong><br>你可以在 <a href=\"/v3/on_page/task_post/\">Task POST</a> 端点的响应中获取此 ID<br>示例：<br><code>\"07131248-1535-0216-1000-17384017ad04\"</code>"
          },
          "url": {
            "type": "string",
            "description": "<em>资源 URL</em><br><strong>必填字段</strong><br>你可以在 <a href=\"/v3/on_page/pages/\">Pages</a> 端点的响应中获取此 URL<br>示例：<br><code>https://dataforseo.com/apis</code>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>用户自定义任务标识符</em><br>可选字段<br><em>字符数上限为 255</em><br>可使用此参数标识任务，并将其与结果对应<br>可在响应的 <code>data</code> 对象中找到指定的 <code>tag</code> 值"
          }
        },
        "example": [
          {
            "id": "02241700-1535-0216-0000-034137259bc1",
            "url": "https://dataforseo.com/apis"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "id": "02241700-1535-0216-0000-034137259bc1",
      "url": "https://dataforseo.com/apis"
    }
  ]
}
```

## Responses

### 200 — 操作成功

Headers:
- `X-Request-Id` (string) — 联系 Felo 支持时需提供的请求标识符。

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_OnPageMicrodataResponseInfo"
    }
  ]
}
```

### 400 — 无法处理该请求。请检查请求参数。

### 401 — 需要有效的 Felo API 密钥。

### 402 — 由于未满足计费要求，请求无法继续。

### 403 — 该账户无权执行此操作。

### 429 — 已达到请求或支出限额。

### 502 — 服务无法完成该请求。

### 503 — API 或计费服务暂时不可用。

### 504 — 服务在处理请求时超时。

### default — 错误响应；上游透传响应可能采用提供方格式

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "API 的当前版本"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "通用状态码\n完整响应码列表见此处"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "通用信息性消息\n完整的一般信息性消息列表见此处"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "总执行时间，秒"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "任务总费用，美元",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "tasks 数组中的任务数",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "tasks 数组中返回错误的任务数",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "任务标识符\n我们系统中 UUID 格式的唯一任务标识符"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "任务的状态码\n由 DataForSEO 生成，范围如下：10000-60000\n完整响应码列表见此处"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "任务的信息性消息\n完整的一般信息性消息列表见此处"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "执行时间，秒"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "任务总费用，美元",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "result 数组中的元素数",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "URL 路径"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "包含你在 POST 请求中指定的相同参数"
    }
  }
}
```

### Response36Afe1097B20_CrawlStatusInfo

`#/components/schemas/Response36Afe1097B20_CrawlStatusInfo`

```json
{
  "type": "object",
  "properties": {
    "max_crawl_pages": {
      "type": [
        "integer",
        "null"
      ],
      "description": "爬取页面数上限\n 表示设置任务时指定的 max_crawl_pages 限制",
      "format": "int64"
    },
    "pages_in_queue": {
      "type": [
        "integer",
        "null"
      ],
      "description": "当前在爬取队列中的页面数量",
      "format": "int64"
    },
    "pages_crawled": {
      "type": [
        "integer",
        "null"
      ],
      "description": "已爬取的页面数量",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_MessageInfo

`#/components/schemas/Response36Afe1097B20_MessageInfo`

```json
{
  "type": "object",
  "properties": {
    "level": {
      "type": [
        "string",
        "null"
      ],
      "description": "错误级别\n可取以下值：fatal、error、warning、info"
    },
    "message": {
      "type": [
        "string",
        "null"
      ],
      "description": "与错误关联的消息\n提供检测到的错误详情的消息"
    }
  }
}
```

### Response36Afe1097B20_MicrodataFieldsInfo

`#/components/schemas/Response36Afe1097B20_MicrodataFieldsInfo`

```json
{
  "type": "object",
  "properties": {
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>字段名</em><br>数据字段的名称"
    },
    "types": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "微数据类型列表"
    },
    "value": {
      "type": [
        "string",
        "null"
      ],
      "description": "微数据值\n目标网页上指定的微数据值"
    },
    "test_results": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_MessageInfo"
        }
      ],
      "description": "<em>微数据验证测试结果</em><br>包含检测到的错误和相关消息的微数据子类型测试结果"
    },
    "fields": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_MicrodataFieldsInfo"
          }
        ]
      },
      "description": "<em>微数据字段</em><br>包含与特定微数据类型相关的数据字段的对象数组"
    }
  }
}
```

### Response36Afe1097B20_MicrodataInspectionInfo

`#/components/schemas/Response36Afe1097B20_MicrodataInspectionInfo`

```json
{
  "type": "object",
  "properties": {
    "types": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "<em>父级微数据类型</em><br>有关可用类型的完整列表，请访问 <a href=\"https://schema.org/docs/full.html\" rel=\"noopener noreferrer\" target=\"_blank\">schema.org</a>"
    },
    "fields": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_MicrodataFieldsInfo"
          }
        ]
      },
      "description": "<em>微数据字段</em><br>包含与特定微数据类型相关的数据字段的对象数组"
    }
  }
}
```

### Response36Afe1097B20_OnPageMicrodataInfoItem

`#/components/schemas/Response36Afe1097B20_OnPageMicrodataInfoItem`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "元素类型"
    },
    "inspection_info": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_MicrodataInspectionInfo"
        }
      ],
      "description": "<em>与微数据验证相关的信息</em>"
    }
  }
}
```

### Response36Afe1097B20_OnPageMicrodataResponseInfo

`#/components/schemas/Response36Afe1097B20_OnPageMicrodataResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_OnPageMicrodataTaskInfo"
              }
            ]
          },
          "description": "<em>任务数组</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_OnPageMicrodataResultInfo

`#/components/schemas/Response36Afe1097B20_OnPageMicrodataResultInfo`

```json
{
  "type": "object",
  "properties": {
    "crawl_progress": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>抓取会话的状态</em><br>可能的值：<code>in_progress</code>、<code>finished</code>"
    },
    "crawl_status": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_CrawlStatusInfo"
        }
      ],
      "description": "<em>抓取会话的详细信息</em>"
    },
    "test_summary": {
      "type": [
        "object",
        "null"
      ],
      "oneOf": [
        {
          "$ref": "#/components/schemas/Response36Afe1097B20_TestSummary"
        }
      ],
      "description": "<em>微数据验证测试结果</em>"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>结果数组中的条目数</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_OnPageMicrodataInfoItem"
          }
        ]
      },
      "description": "<em>条目数组</em>"
    }
  }
}
```

### Response36Afe1097B20_OnPageMicrodataTaskInfo

`#/components/schemas/Response36Afe1097B20_OnPageMicrodataTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_OnPageMicrodataResultInfo"
              }
            ]
          },
          "description": "<em>结果数组</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_TestSummary

`#/components/schemas/Response36Afe1097B20_TestSummary`

```json
{
  "type": "object",
  "properties": {
    "fatal": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>致命的微数据错误数量</em>"
    },
    "error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>严重的微数据错误数量</em>"
    },
    "warning": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>微数据警告数量</em>"
    },
    "info": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>微数据信息标志数量</em>"
    }
  }
}
```