跳转到主要内容
POST
结果保留: 传递 storage.expires_in 以使此地图的存储文件保留时间超过默认的 7 天。可选值:7d、10d、30d、60d、90d、180d、365d 或 never。详情请参见存储。

授权

Authorization
string
header
必填

Bearer认证头格式为Bearer ,其中是你的认证令牌。

请求体

application/json
url
string<uri>
必填

你想要获取链接的网站的 URL

storage
object

控制此地图的存储文件(其结果和发现期间抓取的页面)保留多长时间。如果省略,则保留 7 天。实际生效的值在响应中以 storage.expires_in 返回。请参阅功能文档中的存储部分。无效值返回 400,代码为 invalid_storage_expires_in。

search_query
string

可选的搜索查询,以按搜索相关性对链接进行排序。

top_n
number

可选的数字,仅限于搜索查询的前 n 个链接。

include_subdomain
boolean

包含给定 URL 的子域。默认值为 true。

include_urls
string[]

使用 glob 语法包含的 URL 路径模式。例如:/blog/** 仅包含博客 URL。只有匹配这些模式的 URL 才会被返回。

exclude_urls
string[]

使用 glob 语法排除的 URL 路径模式。例如:/careers/**。排除的 URL 将优先于包含的 URL。

cursor
string

可选:来自上一个响应的分页游标。如果提供,将返回从上一个请求因响应大小限制而中断的地方开始的下一组URL。

响应

成功响应,页面上找到的URL

urls_count
integer
必填

当前响应中的 URL 数量

urls
string[]
必填

页面上找到的 URL 数组

storage
object

应用于此地图存储文件的保留策略。

id
string

此地图的唯一标识符

cursor
string

分页游标,用于检索因10MB大小限制而受限的下一组URL。如果为null或不存在,则表示所有URL已被检索。

credits_consumed
integer | null

此请求消耗的积分数量。在执行完成后填充。积分是计费的真实来源。

cost_usd
number | null

此请求的估计成本(以美元计)。在执行完成后填充。根据消耗的积分和你的计划费率计算——99% 准确,但 credits_consumed 是权威值。