v0.2.0-beta

OpenAPI 3.1.0

设置 Lighthouse 任务

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/lighthouse/task_post

设置 Lighthouse 任务

将 Lighthouse 审计排入队列而不是等待其完成，返回任务 id。当审计耗时超过一次工具调用的等待时间时使用；用 get_dataforseo_on_page_lighthouse_task_get_json 获取结果，用 get_dataforseo_on_page_lighthouse_ready 查看哪些已就绪。采用 DataForSEO 的信封结构：数据位于 tasks[0].result，结果状态位于 tasks[0].status_code——被拒绝的请求仍会返回 HTTP 200。⚠️ 最终仍是同样 245 KB 的报告，因此上下文成本只是延后，并未避免——请在此处用 categories 或 audits 收窄，而不是事后再收窄。

计费参考

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

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

请求体

application/json

类型: array (object | null)[]
- audits
  类型: array string[] | null
  
  Lighthouse 审计项
  可选字段
  审计项是 Lighthouse 针对每个特定功能/优化项/指标运行的单项测试，用于得出数值分数（参见官方定义）如果忽略此字段，我们将返回所有审计项的数据
  使用此字段可获取你在此处指定的特定审计项的数据
  
  注意：有些审计项不属于特定类别，是独立的页面质量衡量指标
  
  一般来说，可能有以下几种使用情形：
  
  1. 如果忽略 categories，你可以使用此字段仅获取指定审计项的数据
  例如，如果忽略 "categories" 并指定 "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"]，你将仅获取这些审计项的数据
  
  2. 如果指定了类别，你可以使用此字段额外接收不属于你所指定类别的审计项
  例如，如果指定 "categories": ["seo"] 和 "audits": ["metrics/cumulative-layout-shift","metrics/largest-contentful-paint","metrics/total-blocking-time"]，你将仅获取 "performance" 下的这些审计项，以及 "seo" 下的所有审计项
  
  你可以在此处获取所有可能的审计项列表
- browser_cpu_throttling_multiplier
  类型: number | null
  
  浏览器 CPU 节流倍数
  当 browser_network_throttling_method 设为 devtools 时为必填；
  设置 CPU 节流倍数，以在 Lighthouse 审计期间模拟设备性能状况；
  可在以下范围内指定：1–4；
  注意：仅当 browser_network_throttling_method 设为 devtools 时才会应用此参数；
- browser_network_throttling
  类型: string | null
  
  浏览器网络节流
  当 browser_network_throttling_method 设为 devtools 时为必填；
  设置网络节流配置文件，以在 Lighthouse 审计期间模拟连接速度状况；
  可选值：no_throttling、fast_4g、slow_4g、regular_3g、pc；
  注意：仅当 browser_network_throttling_method 设为 devtools 时才会应用此参数；
- browser_network_throttling_method
  类型: string | null
  
  浏览器网络节流方法
  可选字段
  定义 Lighthouse 审计期间应用节流的方法；
  可选值：
  simulate - 在不施加显式节流的情况下计算预估的性能指标；
  devtools - 应用 browser_network_throttling 和 browser_cpu_throttling_multiplier 中指定的节流设置；
  provided - 使用抓取环境的网络状况；
- browser_screen_height
  类型: integer | null
  
  浏览器屏幕高度
  可选字段
  设置用于 Lighthouse 审计的浏览器屏幕高度，以模拟特定设备；
  可在以下范围内指定：240–9999；
- browser_screen_scale_factor
  类型: number | null
  
  浏览器屏幕缩放比例
  可选字段
  设置用于 Lighthouse 审计的浏览器的设备像素比；
  可在以下范围内指定：0.5–3；
- browser_screen_width
  类型: integer | null 格式: int64
  
  浏览器屏幕宽度
  可选字段
  设置用于 Lighthouse 审计的浏览器屏幕宽度，以模拟特定设备；
  可在以下范围内指定：240–9999；
- categories
  类型: array string[] | null
  
  Lighthouse 审计类别
  可选字段
  每个类别是审计项和审计组的集合，会对该部分应用权重和评分（参见官方定义）如果忽略此字段，我们将返回所有类别的数据，除非你指定了 audits
  使用此字段可获取你在此处指定的特定类别的数据
  
  可选值：
  seo、performance、best_practices、accessibility
- custom_user_agent
  类型: string | null
  
  自定义用户代理
  可选字段
  指定浏览器在运行 Lighthouse 审计时使用的自定义用户代理；
  最多可指定 254 个字符；
- for_mobile
  类型: boolean | null
  
  应用移动设备模拟
  可选字段
  如果设为 true，Lighthouse 将使用移动设备和屏幕模拟，以移动环境测试页面
  如果设为 false，将提供桌面端的结果
  默认值：false
- language_code
  类型: string | null
  
  Lighthouse 语言代码
  可选字段
  你可以单独向 https://api.dataforseo.com/v3/on_page/lighthouse/languages 发起请求，获取搜索引擎可用语言及其 language_code 的列表
  默认值：
  en
- language_name
  类型: string | null
  
  Lighthouse 语言名称
  可选字段
  你可以单独向 https://api.dataforseo.com/v3/on_page/lighthouse/languages 发起请求，获取搜索引擎可用语言及其 language_name 的列表
  默认值：
  English
- pingback_url
  类型: string | null
  
  已完成任务的通知 URL
  可选字段
  任务完成后，我们会向你指定的 URL 发送 GET 请求进行通知
  你可以将 ‘$id’ 字符串用作 $id 变量，将 ‘$tag’ 用作 URL 编码的 $tag 变量。发送请求前，我们会设置必要的值。
  示例：
  http://your-server.com/pingscript?id=$id
  http://your-server.com/pingscript?id=$id&tag=$tag
  注意：pingback_url 中的特殊字符会被 URL 编码；
  例如，# 字符会被编码为 %23。更多信息请参阅我们的帮助中心
- tag
  类型: string | null
  
  用户自定义任务标识符
  可选字段
  字符数上限为 255
  可使用此参数标识任务，并将其与结果对应
  可在响应的 data 对象中找到指定的 tag 值
- url
  类型: string
  
  目标 URL
  必填字段
  目标页面应使用绝对 URL 指定（包含 http:// 或 https://）
  示例：
  https://dataforseo.com/
- version
  类型: string | null
  
  Lighthouse 版本
  可选字段
  指定版本号即可获取特定 Lighthouse 版本的结果
  可用版本列表可通过 Lighthouse Versions 端点获取

响应

200
类型: object | null · Response36Afe1097B20_OnPageLighthouseTaskPostResponseInfo
cost
类型: number | null 格式: double

任务总费用，美元

status_code
类型: integer | null

通用状态码完整响应码列表见此处

status_message
类型: string | null

通用信息性消息完整的一般信息性消息列表见此处

tasks
类型: array (object | null)[] | null

任务数组

类型: object | null · Response36Afe1097B20_OnPageLighthouseTaskPostTaskInfo
cost
类型: number | null 格式: double

任务总费用，美元

data
类型: object | null

包含你在 POST 请求中指定的相同参数

propertyName
类型: object | null
id
类型: string | null

任务标识符我们系统中 UUID 格式的唯一任务标识符

path
类型: array (string | null)[] | null

URL 路径

result
类型: array (object | null)[] | null
propertyName
类型: object | null
result_count
类型: integer | null 格式: int64

result 数组中的元素数

status_code
类型: integer | null

任务的状态码由 DataForSEO 生成，范围如下：10000-60000 完整响应码列表见此处

status_message
类型: string | null

任务的信息性消息完整的一般信息性消息列表见此处

time
类型: string | null

执行时间，秒

tasks_count
类型: integer | null 格式: int64

tasks 数组中的任务数

tasks_error
类型: integer | null 格式: int64

tasks 数组中返回错误的任务数

time
类型: string | null

总执行时间，秒

version
类型: string | null

API 的当前版本
application/json
400

无法处理该请求。请检查请求参数。
401

需要有效的 Felo API 密钥。
402

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

该账户无权执行此操作。
429

已达到请求或支出限额。
502

服务无法完成该请求。
503

API 或计费服务暂时不可用。
504

服务在处理请求时超时。
default

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

application/json

post/v1/beta/dataforseo/on_page/lighthouse/task_post

curl https://openapi.felo.ai/v1/beta/dataforseo/on_page/lighthouse/task_post \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "url": "https://dataforseo.com",
    "for_mobile": true,
    "tag": "some_string_123",
    "pingback_url": "https://your-server.com/pingscript?id=$id&tag=$tag"
  }
]'

显示 Schema

{
  "version": null,
  "status_code": null,
  "status_message": null,
  "time": null,
  "cost": null,
  "tasks_count": null,
  "tasks_error": null,
  "tasks": [
    {
      "id": null,
      "status_code": null,
      "status_message": null,
      "time": null,
      "cost": null,
      "result_count": null,
      "path": [
        null
      ],
      "data": null,
      "result": [
        null
      ]
    }
  ]
}

操作成功

需要帮助？

API、计费或账号问题，请联系支持。
在 Discord 上与 Felo 开发者交流。
查看我们的更新日志。
需要批量定价或采购支持？联系销售。
正在使用 LLM 构建？阅读 llms.txt。

设置 Lighthouse 任务

身份验证Required

DataForSEO

设置 Lighthouse 任务

计费参考

需要帮助？