# OnPage API 内容解析
**API:** Data API
**Endpoint:** `POST /v1/beta/dataforseo/on_page/content_parsing`
**Tags:** DataForSEO
将单个已抓取的 `url` 解析为结构化内容，并提供 `markdown_view` 用于 Markdown 渲染。它读取已完成的抓取，因此需要 `post_dataforseo_on_page_submit` 返回的 `id`，并返回 `crawl_progress` 以及由 `max_crawl_pages`、`pages_in_queue` 和 `pages_crawled` 组成的 `crawl_status`——在相信一个很小的结果之前请先检查这些字段，因为仍在运行的抓取本来就没有多少可报告的内容。独立版本 `post_dataforseo_on_page_content_parsing_live` 可在没有抓取的情况下解析任意 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": {
"url": {
"type": "string",
"description": "要解析的内容 URL
必填字段
要解析的页面 URL
示例：
`https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api`"
},
"id": {
"type": "string",
"description": "任务 ID
必填字段
你可以在 Task POST 端点的响应中获取此 ID
注意：POST 请求中的 enable_content_parsing 参数必须设为 true
示例：
\"07131248-1535-0216-1000-17384017ad04\""
},
"markdown_view": {
"type": [
"boolean",
"null"
],
"description": "以 markdown 返回页面内容
可选字段
如果设为 true，页面以 markdown 格式呈现的内容将在响应的 page_as_markdown 字段中返回；
默认值：false"
}
},
"example": [
{
"url": "https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api",
"id": "11161551-1535-0216-0000-500b3f307f92"
}
]
}
]
},
"example": [
{
"url": "https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api",
"id": "11161551-1535-0216-0000-500b3f307f92"
}
]
}
```
## Responses
### 200 — 操作成功
Headers:
- `X-Request-Id` (string) — 联系 Felo 支持时需提供的请求标识符。
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_OnPageContentParsingResponseInfo"
}
]
}
```
### 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_Contacts
`#/components/schemas/Response36Afe1097B20_Contacts`
```json
{
"type": "object",
"properties": {
"telephones": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "电话号码数组
"
},
"emails": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "电子邮件地址数组
"
}
}
}
```
### Response36Afe1097B20_ContentCommentInfo
`#/components/schemas/Response36Afe1097B20_ContentCommentInfo`
```json
{
"type": "object",
"properties": {
"rating": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContententRatingInfo"
}
],
"description": "商品评分\n包含客户对该商品所给评分的信息"
},
"title": {
"type": [
"string",
"null"
],
"description": "客户评论的标题"
},
"publish_date": {
"type": [
"string",
"null"
],
"description": "评论发布的日期"
},
"author": {
"type": [
"string",
"null"
],
"description": "评论作者"
},
"have_form": {
"type": [
"boolean",
"null"
],
"description": ""
},
"primary_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SectionContentItemInfo"
}
]
},
"description": "页面上的主要内容\n如需了解内容优先级计算的更多信息，请参阅此帮助中心文章"
}
}
}
```
### Response36Afe1097B20_ContentOfferInfo
`#/components/schemas/Response36Afe1097B20_ContentOfferInfo`
```json
{
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
],
"description": "商品名称"
},
"price": {
"type": [
"number",
"null"
],
"description": "商品价格",
"format": "double"
},
"price_currency": {
"type": [
"string",
"null"
],
"description": "价格货币"
},
"price_valid_until": {
"type": [
"string",
"null"
],
"description": "显示价格有效期截止的日期和时间\n采用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”\n示例：\"2022-11-01 10:02:52 +00:00\""
}
}
}
```
### Response36Afe1097B20_ContentParsingElement
`#/components/schemas/Response36Afe1097B20_ContentParsingElement`
```json
{
"type": "object",
"properties": {
"type": {
"type": [
"string",
"null"
],
"description": "元素类型"
},
"fetch_time": {
"type": [
"string",
"null"
],
"description": "内容获取的日期和时间
示例：
\"2022-11-01 10:02:52 +00:00\""
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "通用状态码
完整响应码列表见此处
注意：我们强烈建议设计必要的系统来处理相关的异常或错误情况"
},
"page_content": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_PageContentInfo"
}
],
"description": "页面的解析内容
"
},
"page_as_markdown": {
"type": [
"string",
"null"
],
"description": "Markdown 格式的页面内容
采用 文本转 HTML 的 Markdown 格式的页面内容
在请求中将 markdown_view 指定为 true 可返回该值"
}
}
}
```
### Response36Afe1097B20_ContentUrlInfo
`#/components/schemas/Response36Afe1097B20_ContentUrlInfo`
```json
{
"type": "object",
"properties": {
"url": {
"type": [
"string",
"null"
],
"description": "包含在内容元素中找到的其他 URL 和锚文本"
},
"anchor_text": {
"type": [
"string",
"null"
],
"description": "URL 锚文本"
}
}
}
```
### Response36Afe1097B20_ContententRatingInfo
`#/components/schemas/Response36Afe1097B20_ContententRatingInfo`
```json
{
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
],
"description": "评分名称\n此处可找到以下元素：Max5、Percents、CustomMax"
},
"rating_value": {
"type": [
"number",
"null"
],
"description": "评分的值",
"format": "double"
},
"rating_count": {
"type": [
"integer",
"null"
],
"description": "投票数",
"format": "int64"
},
"max_rating_value": {
"type": [
"number",
"null"
],
"description": "评分名称的最大值",
"format": "double"
},
"relative_rating": {
"type": [
"number",
"null"
],
"description": "相对评分",
"format": "double"
}
}
}
```
### 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_OnPageContentParsingResponseInfo
`#/components/schemas/Response36Afe1097B20_OnPageContentParsingResponseInfo`
```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_OnPageContentParsingTaskInfo"
}
]
},
"description": "任务数组"
}
}
}
]
}
```
### Response36Afe1097B20_OnPageContentParsingResultInfo
`#/components/schemas/Response36Afe1097B20_OnPageContentParsingResultInfo`
```json
{
"type": "object",
"properties": {
"crawl_progress": {
"type": [
"string",
"null"
],
"description": "抓取会话的状态
可能的值：in_progress、finished"
},
"crawl_status": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_CrawlStatusInfo"
}
],
"description": "抓取会话的详细信息"
},
"items_count": {
"type": [
"integer",
"null"
],
"description": "结果数组中的条目数
",
"format": "int64"
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContentParsingElement"
}
]
},
"description": "条目数组
"
}
}
}
```
### Response36Afe1097B20_OnPageContentParsingTaskInfo
`#/components/schemas/Response36Afe1097B20_OnPageContentParsingTaskInfo`
```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_OnPageContentParsingResultInfo"
}
]
},
"description": "结果数组"
}
}
}
]
}
```
### Response36Afe1097B20_PageContentInfo
`#/components/schemas/Response36Afe1097B20_PageContentInfo`
```json
{
"type": "object",
"properties": {
"header": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_PageSectionContentInfo"
}
],
"description": "表头的解析内容
"
},
"footer": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_PageSectionContentInfo"
}
],
"description": "表格页脚的内容
"
},
"main_topic": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TopicInfo"
}
]
},
"description": "页面的主要主题
如需了解主题优先级计算的更多信息，请参阅这篇帮助中心文章
"
},
"secondary_topic": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TopicInfo"
}
]
},
"description": "页面的次要主题
如需了解主题优先级计算的更多信息，请参阅这篇帮助中心文章
"
},
"ratings": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContententRatingInfo"
}
]
},
"description": "包含页面上所显示产品的评分信息对象
"
},
"offers": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContentOfferInfo"
}
]
},
"description": "页面上显示的产品数组
包含页面上所显示产品相关信息的对象"
},
"comments": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContentCommentInfo"
}
]
},
"description": "页面上显示的评论数组
包含与所显示产品相关评论信息的对象"
},
"contacts": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_Contacts"
}
],
"description": "联系信息
包含页面上显示的联系信息"
}
}
}
```
### Response36Afe1097B20_PageSectionContentInfo
`#/components/schemas/Response36Afe1097B20_PageSectionContentInfo`
```json
{
"type": "object",
"properties": {
"primary_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SectionContentItemInfo"
}
]
},
"description": "页面上的主要内容
有关内容优先级计算的更多信息，请参阅这篇帮助中心文章
"
},
"secondary_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SectionContentItemInfo"
}
]
},
"description": "页面上的次要内容
有关内容优先级计算的更多信息，请参阅这篇帮助中心文章
"
},
"table_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TableContentInfo"
}
]
},
"description": "页面上表格的内容
"
}
}
}
```
### Response36Afe1097B20_RowCellInfo
`#/components/schemas/Response36Afe1097B20_RowCellInfo`
```json
{
"type": "object",
"properties": {
"text": {
"type": [
"string",
"null"
],
"description": "表头各单元格的内容"
},
"urls": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContentUrlInfo"
}
]
},
"description": "包含在内容元素中找到的其他 URL 和锚文本"
},
"is_header": {
"type": [
"boolean",
"null"
],
"description": "表头各单元格的内容"
}
}
}
```
### Response36Afe1097B20_SectionContentItemInfo
`#/components/schemas/Response36Afe1097B20_SectionContentItemInfo`
```json
{
"type": "object",
"properties": {
"text": {
"type": [
"string",
"null"
],
"description": "页面上的次要内容\n有关内容优先级计算的更多信息，请参阅这篇帮助中心文章"
},
"url": {
"type": [
"string",
"null"
],
"description": "页面 URL。\n当文本为链接锚文本时显示"
},
"urls": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_ContentUrlInfo"
}
]
},
"description": "包含在内容元素中找到的其他 URL 和锚文本"
}
}
}
```
### Response36Afe1097B20_TableContentInfo
`#/components/schemas/Response36Afe1097B20_TableContentInfo`
```json
{
"type": "object",
"properties": {
"header": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TableContentItemInfo"
}
]
},
"description": "解析后的表头内容"
},
"body": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TableContentItemInfo"
}
]
},
"description": "表格主体的内容"
},
"footer": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TableContentItemInfo"
}
]
},
"description": "表格页脚的内容"
}
}
}
```
### Response36Afe1097B20_TableContentItemInfo
`#/components/schemas/Response36Afe1097B20_TableContentItemInfo`
```json
{
"type": "object",
"properties": {
"row_cells": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_RowCellInfo"
}
]
},
"description": "表头各单元格的内容"
}
}
}
```
### Response36Afe1097B20_TopicInfo
`#/components/schemas/Response36Afe1097B20_TopicInfo`
```json
{
"type": "object",
"properties": {
"h_title": {
"type": [
"string",
"null"
],
"description": "元标题
"
},
"main_title": {
"type": [
"string",
"null"
],
"description": " 区块主标题
"
},
"author": {
"type": [
"string",
"null"
],
"description": "内容作者姓名
"
},
"language": {
"type": [
"string",
"null"
],
"description": "内容语言
"
},
"level": {
"type": [
"integer",
"null"
],
"description": "HTML 层级
"
},
"primary_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SectionContentItemInfo"
}
]
},
"description": "页面上的主要内容
有关内容优先级计算的更多信息，请参阅这篇帮助中心文章
"
},
"secondary_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SectionContentItemInfo"
}
]
},
"description": "页面上的次要内容
有关内容优先级计算的更多信息，请参阅这篇帮助中心文章
"
},
"table_content": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_TableContentInfo"
}
]
},
"description": "页面上表格的内容
"
}
}
}
```