# 链接

**API:** Data API

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

**Tags:** DataForSEO

按 `id` 获取爬取过程中发现的每个链接。用 `page_from` 和 `page_to` 过滤，取出从某个页面出去或指向某个页面的链接。返回 `total_items_count`、`items_count`、`items`，以及用于分页的 `search_after_token`——前几页之后请用它，而不是 `offset`。读取已完成的爬取，因此需要 `post_dataforseo_on_page_submit` 返回的 `id`，并返回 `crawl_progress` 以及 `crawl_status`（`max_crawl_pages`、`pages_in_queue` 和 `pages_crawled`）——在采信偏少的结果前先检查这些字段，因为仍在进行的爬取能报告的内容本来就少。💰 上游免费：查询已完成的爬取不产生费用，只有爬取本身计费。

### 计费参考

- 计量方式：按上报的响应成本计量。
- 参考请求估算：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=\"https://docs.dataforseo.com/v3/on_page/task_post/\">Task POST</a> 端点的响应中获取此 ID<br>示例：<br>\"07131248-1535-0216-1000-17384017ad04\""
          },
          "page_from": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>页面相对 URL</em><br>可选字段<br>如果使用此字段，API 响应将仅包含来自指定页面的链接<br>请注意，此字段只能指定相对 URL"
          },
          "page_to": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>页面相对 URL</em><br>可选字段<br>如果使用此字段，API 响应将仅包含指向指定页面的内部链接<br>请注意，此字段只能指定相对 URL"
          },
          "limit": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>返回链接的最大数量</em><br>可选字段<br>默认值：<code>100</code><br>最大值：<code>1000</code>"
          },
          "offset": {
            "type": [
              "integer",
              "null"
            ],
            "description": "<em>返回链接结果数组中的偏移量</em><br>可选字段<br>默认值：<code>0</code><br>最大值：<code>2000000</code><br>如果指定 <code>10</code>，结果数组中的前十个链接将被省略，数据将针对后续链接提供"
          },
          "filters": {
            "type": [
              "array",
              "null"
            ],
            "items": {
              "type": [
                "object",
                "null"
              ]
            },
            "description": "<em>结果筛选参数数组</em><br>可选字段<br><strong>可同时添加多个筛选条件（最多 8 个）</strong><br>应在条件之间设置逻辑运算符 <code>and</code>、<code>or</code><br>支持以下运算符：<br><code>regex</code>、<code>not_regex</code>、<code>=</code>、<code>&lt;&gt;</code>、<code>in</code>、<code>not_in</code>、<code>like</code>、<code>not_like</code><br>可以将 <code>%</code> 运算符与 <code>like</code> 和 <code>not_like</code> 一起使用，匹配任意长度（零个或多个字符）的字符串<br>示例：<br><code>[\"direction\",\"=\",\"external\"]</code><p><code>[[\"domain_to\",\"&lt;&gt;\",\"example.com\"],<br>\"and\",<br>[\"link_from\",\"not_like\",\"%example.com/blog%\"]]</code><p><code>[[\"direction\",\"=\",\"external\"],<br>\"and\",<br>[[\"link_from\",\"like\",\"%example.com/blog%\"],\"or\",[\"link_from\",\"like\",\"%example.com/help%\"]]]</code><p>完整可用筛选器列表请见<a href=\"/v3/on_page/filters_and_thresholds/?bash\" rel=\"noopener noreferrer\" target=\"_blank\">此链接。</a>"
          },
          "search_after_token": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>后续请求的令牌</em><br>可选字段<br>在每个请求响应的对应字段中提供；<br>使用此参数可避免在单个请求中尝试获取超过 <code>20,000</code> 条结果时超时；<br>通过指定响应数组中的唯一 <code>search_after_token</code> 值，可获取初始任务的后续结果；<br><code>search_after_token</code> 值对每个后续任务都是唯一的；<br><strong>注意：</strong>如果请求中指定了 <code>search_after_token</code>，其他所有参数都应与此前的请求完全相同"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>用户自定义任务标识符</em><br>可选字段<br><em>字符数上限为 255</em><br>可使用此参数标识任务，并将其与结果对应<br>可在响应的 <code>data</code> 对象中找到指定的 <code>tag</code> 值"
          }
        },
        "example": [
          {
            "id": "07281559-0695-0216-0000-c269be8b7592",
            "page_from": "/apis/google-trends-api",
            "filters": [
              [
                "dofollow",
                "=",
                true
              ],
              "and",
              [
                "direction",
                "=",
                "external"
              ]
            ],
            "limit": 10
          }
        ]
      }
    ]
  },
  "example": [
    {
      "id": "07281559-0695-0216-0000-c269be8b7592",
      "page_from": "/apis/google-trends-api",
      "filters": [
        [
          "dofollow",
          "=",
          true
        ],
        "and",
        [
          "direction",
          "=",
          "external"
        ]
      ],
      "limit": 10
    }
  ]
}
```

## Responses

### 200 — 操作成功

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

**application/json**

Schema: object | null

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

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

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

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

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

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

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

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

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

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

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BaseOnPageLinkItem

`#/components/schemas/Response36Afe1097B20_BaseOnPageLinkItem`

```json
{
  "type": "object",
  "properties": {
    "type": {
      "type": [
        "string",
        "null"
      ],
      "description": "元素类型"
    },
    "domain_from": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>引用域名</em><br>该链接是在此域名上发现的"
    },
    "domain_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>被引用域名</em><br>该链接指向此域名"
    },
    "page_from": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>引用页面</em><br>发现该链接的页面的相对 URL"
    },
    "page_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>被引用页面</em><br>该链接所指向页面的相对 URL"
    },
    "link_from": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>引用页面</em><br>发现该链接的页面的绝对 URL"
    },
    "link_to": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>被引用页面</em><br>该链接所指向页面的绝对 URL"
    },
    "dofollow": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>表示链接是否为 dofollow</em><br>如果值为 <code>true</code>，则该链接没有 <code>rel=\"nofollow\"</code> 属性"
    },
    "page_from_scheme": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>引用页面的 <a href=\"https://en.wikipedia.org/wiki/List_of_URI_schemes\" target=\"_blank\" rel=\"noopener noreferrer\">URL 方案</a></em>"
    },
    "page_to_scheme": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>被引用页面的 <a href=\"https://en.wikipedia.org/wiki/List_of_URI_schemes\" target=\"_blank\" rel=\"noopener noreferrer\">URL 方案</a></em>"
    },
    "direction": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>链接方向</em><br>可能的值：<code>internal</code>、<code>external</code>"
    },
    "is_broken": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>链接已失效</em><br>表示链接是否指向失效的页面或资源"
    },
    "is_link_relation_conflict": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "<em>表示该链接可能与其他链接存在冲突</em><br>如果为 <code>true</code>，则至少有一个指向 <code>link_to</code> 的链接具有 <code>rel=\"nofollow\"</code> 属性，<strong>并且</strong>至少有一个是 dofollow"
    },
    "page_to_status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>被引用页面的状态码</em><br>该链接所指向页面的状态码"
    }
  },
  "additionalProperties": false,
  "discriminator": {
    "propertyName": "type",
    "mapping": {
      "anchor": "#/components/schemas/Response36Afe1097B20_OnPageAnchorLinkItem",
      "image": "#/components/schemas/Response36Afe1097B20_OnPageImageLinkItem",
      "canonical": "#/components/schemas/Response36Afe1097B20_OnPageCanonicalLinkItem",
      "alternate": "#/components/schemas/Response36Afe1097B20_OnPageAlternateLinkItem",
      "link": "#/components/schemas/Response36Afe1097B20_OnPageLinkLinkItem",
      "redirect": "#/components/schemas/Response36Afe1097B20_OnPageRedirectLinkItem",
      "meta": "#/components/schemas/Response36Afe1097B20_OnPageMetaLinkItem"
    }
  }
}
```

### 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_OnPageLinksResponseInfo

`#/components/schemas/Response36Afe1097B20_OnPageLinksResponseInfo`

```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_OnPageLinksTaskInfo"
              }
            ]
          },
          "description": "<em>任务数组</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_OnPageLinksResultInfo

`#/components/schemas/Response36Afe1097B20_OnPageLinksResultInfo`

```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>"
    },
    "search_after_token": {
      "type": [
        "string",
        "null"
      ]
    },
    "current_offset": {
      "type": [
        "integer",
        "null"
      ]
    },
    "total_items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>数据库中相关条目的总数</em>",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>结果数组中的条目数</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_BaseOnPageLinkItem"
          }
        ]
      },
      "description": "<em>条目数组</em>"
    }
  }
}
```

### Response36Afe1097B20_OnPageLinksTaskInfo

`#/components/schemas/Response36Afe1097B20_OnPageLinksTaskInfo`

```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_OnPageLinksResultInfo"
              }
            ]
          },
          "description": "<em>结果数组</em>"
        }
      }
    }
  ]
}
```