设置 Lighthouse 任务
OnPage Lighthouse API 基于 Google 的开源 Lighthouse 项目,用于衡量网页和 Web 应用的质量。
授权
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
请求体
目标 URL 必填字段;应使用绝对 URL(包括 http:// 或 https://)指定目标页面;示例:https://dataforseo.com/
应用移动设备模拟;可选字段。如果设置为 true,Lighthouse 将使用移动设备和屏幕模拟,在移动环境下测试页面;如果设置为 false,将提供桌面端结果。默认值:false。
Lighthouse 审核类别,可选字段。每个类别均为审核项和审核组的集合,用于对相应部分进行加权和评分(参见官方定义)。如果忽略此字段,除非指定 audits,否则我们将返回所有类别的数据。使用此字段可获取此处指定类别的数据。可用值:seo、performance、best_practices、accessibility
Lighthouse 审核 可选字段 audits 是 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" 下的所有审核 您可以在此处获取所有可用审核的完整列表
Lighthouse 版本;可选字段;通过指定版本号,您可以获取特定 Lighthouse 版本的结果;可用版本列表可通过 Lighthouse Versions 端点获取
Lighthouse 语言名称;可选字段;可通过向 https://api.dataforseo.com/v3/on_page/lighthouse/languages 单独发起请求,获取搜索引擎的可用语言及其 language_name 列表;默认值:English
Lighthouse 语言代码,可选字段。您可以通过向 https://api.dataforseo.com/v3/on_page/lighthouse/languages 单独发送请求,获取搜索引擎可用语言及其 language_code 的列表。默认值:en
用户定义的任务标识符。可选字段。字符数限制为 255。您可以使用此参数标识任务并将其与结果匹配;您将在响应的 data 对象中找到指定的 tag 值
已完成任务的通知 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;请在我们的帮助中心了解更多信息
响应
成功响应
API 的当前版本
通用状态码;您可以在此处查看完整的响应码列表。注意:我们强烈建议设计必要的系统来处理相关异常或错误情况
常规信息消息;可在此处查看常规信息消息的完整列表
执行时间(秒)
任务总成本(美元)
tasks 数组中的任务数量
返回错误的 tasks 数组中的任务数量
任务数组
任务标识符,系统中采用 UUID 格式的唯一任务标识符
DataForSEO 生成的任务状态码;范围为:10000-60000;完整响应代码列表可在此处查看
任务的信息性消息,你可以在此处查看通用信息性消息的完整列表
执行时间(秒)
任务成本(美元)
结果数组中的元素数量
URL 路径
包含您在 POST 请求中指定的相同参数
结果数组;在此情况下,该值将为 null