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 任務

計費參考

需要協助嗎？