v0.2.0-beta

OpenAPI 3.1.0

歷史排名概覽

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/dataforseo_labs/google/historical_rank_overview/live

歷史排名概覽

某個網域在可用歷史中每個時間點的排名概覽。此端點不接受 limit 參數，但依呼叫次數而非項目計費，因此請一次提交整個清單。採用 DataForSEO 的信封結構：資料位於 tasks[0].result，結果狀態位於 tasks[0].status_code——被拒絕的請求仍會傳回 HTTP 200。請先查看 get_dataforseo_labs_google_available_history——它列出存在的日期，要求超出範圍的日期會傳回空結果，而不是錯誤。目前的快照是 post_dataforseo_labs_google_domain_rank_overview_live。

計費參考

計量方式：依回報的回應成本計量。
參考請求估算：0.1356 美元。
參考客戶倍率：1.0。不得對已結算的客戶金額再次套用。

僅供參考的中繼資料，並非帳戶報價、保證價格或消費上限。資源額度並非 Felo 額度。最終費用依 Felo 計費記錄為準。

請求本文

application/json

類型: array (object | null)[]
- correlate
  類型: boolean | null
  
  將資料與先前取得的資料集關聯
  選填欄位
  預設值：true
  如果使用此參數，我們的系統會將您現在取得的資料與先前取得的資料集關聯
  此參數旨在減少因資料庫變更而可能產生的不一致
  建議一律將 correlate 設為 true
- date_from
  類型: string | null
  
  時間範圍的開始日期
  選填欄位
  如果未指定此欄位，將提供過去 6 個月的資料
  最小可能值：2020-10-01
  日期格式："yyyy-mm-dd"
- date_to
  類型: string | null
  
  時間範圍的結束日期
  選填欄位
  如果未指定此欄位，預設使用今天的日期
  日期格式："yyyy-mm-dd"
  範例：
  "2021-04-01"
- ignore_synonyms
  類型: boolean | null
  
  忽略高度相似的關鍵字
  選填欄位
  如果設為 true，則只傳回以核心關鍵字為基礎的資料，所有高度相似關鍵字的資料都將被排除；
  預設值：false
- include_clickstream_data
  類型: boolean | null
  
  在結果中包含或排除以點擊流為基礎的指標資料
  選填欄位
  如果參數設為 true，回應中將包含帶有點擊流資料的 clickstream_etv、clickstream_gender_distribution 與 clickstream_age_distribution 欄位；
  預設值：false；
  
  注意：歷史點擊流資料自 2024/05（2024 年 5 月）起提供；
  啟用此參數後，該請求將以雙倍價格計費；
  有關以點擊流為基礎的指標如何計算的更多資訊，請參閱這篇說明中心文章
- language_code
  類型: string | null
  
  語言代碼
  未指定 language_name 時為必填欄位
  注意：必須指定 language_name 或 language_code
  可個別向
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages 發出請求，取得可用地點及其 language_code 的清單
  範例：
  en
- language_name
  類型: string
  
  語言全名
  未指定 language_code 時為必填欄位
  注意：必須指定 language_name 或 language_code
  可個別向
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages 發出請求，取得可用地點及其 language_name 的清單
  範例：
  English
- location_code
  類型: integer
  
  地點代碼
  未指定 location_name 時為必填欄位
  注意：必須指定 location_name 或 location_code
  可個別向
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages 發出請求，取得可用地點及其 location_code 的清單
  範例：
  2840
- location_name
  類型: string
  
  地點全名
  未指定 location_code 時為必填欄位
  注意：必須指定 location_name 或 location_code
  可個別向
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages 發出請求，取得可用地點及其 location_name 的清單
  範例：
  United Kingdom
- tag
  類型: string | null
  
  使用者自訂任務識別碼
  選填欄位
  字元數上限為 255
  可使用此參數識別任務，並將其與結果對應
  可在回應的 data 物件中找到指定的 tag 值
- target
  類型: string
  
  網域
  必填欄位
  目標網站的網域名稱
  網域不需包含 https:// 與 www.

回應

200
類型: object | null · Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResponseInfo
cost
類型: number | null 格式: double

任務總費用，美元

status_code
類型: integer | null

一般狀態碼完整回應碼清單請見此處

status_message
類型: string | null

一般資訊訊息完整的一般資訊訊息清單請見此處

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

任務陣列

類型: object | null · Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveTaskInfo
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

結果陣列

items
類型: array (object | null)[] | null

包含歷史排名與流量資料

metrics
類型: object | null

與指定網域相關的排名資料

propertyName
類型: object · Response36Afe1097B20_DataforseoLabsMetricsInfo
clickstream_age_distribution
類型: object | null

依年齡劃分、以點擊流為基礎的指標分佈
若要取得此欄位的結果，參數 include_clickstream_data 必須設為 true
如需瞭解該指標的計算方式，請參閱這篇說明中心文章

propertyName
類型: integer | null 格式: int64

Signed 64-bit integers (long type).

clickstream_etv
類型: number | null 格式: double

以點擊流資料為基礎的預估流量
由網域所排名之所有關鍵字的點擊率（CTR）與點擊流搜尋量值的乘積計算
若要取得此欄位的結果，參數 include_clickstream_data 必須設為 true
如需瞭解該指標的計算方式，請參閱這篇說明中心文章

clickstream_gender_distribution
類型: object | null

依性別劃分的預估點擊流指標分佈
若要取得此欄位的結果，參數 include_clickstream_data 必須設為 true
如需瞭解該指標的計算方式，請參閱這篇說明中心文章

propertyName
類型: integer | null 格式: int64

Signed 64-bit integers (long type).

count
類型: integer | null 格式: int64

包含該網域或子網域的自然 SERP 總數

estimated_paid_traffic_cost
類型: number | null

將自然搜尋流量轉為付費流量的預估成本
表示網域或子網域在類別中排名之所有關鍵字的預估每月廣告成本（美元）
該指標以自然 etv 與付費 cpc 值的乘積計算，表示透過 Google 搜尋中的 PPC 廣告帶來預估每月自然流量所需的成本
如需瞭解該指標的計算方式，請參閱這篇說明中心文章

etv
類型: number | null

預估流量
該網域或子網域的預估自然搜尋月流量
由該網域或子網域在類別中排名的所有關鍵字的 CTR（點擊率）與搜尋量乘積計算得出
如需瞭解該指標的計算方式，請參閱這篇說明中心文章

is_down
類型: integer | null

排名下降
表示指定目標有多少排名元素下降

is_lost
類型: integer | null

遺失的排名元素
表示指定目標有多少排名元素先前出現於 SERP 中，但於上次檢查時未找到

is_new
類型: integer | null

新增排名元素數量
表示指定目標找到多少個新的排名元素

is_up
類型: integer | null

排名上升
表示指定目標有多少排名元素上升

pos_1
類型: integer | null

網域或子網域排名第 1 名的自然 SERP 數量

pos_11_20
類型: integer | null

網域或子網域排名第 11-20 名的自然 SERP 數量

pos_2_3
類型: integer | null

網域或子網域排名第 2-3 名的自然 SERP 數量

pos_21_30
類型: integer | null

網域或子網域排名第 21-30 名的自然 SERP 數量

pos_31_40
類型: integer | null

網域或子網域排名第 31-40 名的自然 SERP 數量

pos_4_10
類型: integer | null

網域或子網域排名第 4-10 名的自然 SERP 數量

pos_41_50
類型: integer | null

網域或子網域排名第 41-50 名的自然 SERP 數量

pos_51_60
類型: integer | null

網域或子網域排名第 51-60 名的自然 SERP 數量

pos_61_70
類型: integer | null

網域或子網域排名第 61-70 名的自然 SERP 數量

pos_71_80
類型: integer | null

網域或子網域排名第 71-80 名的自然 SERP 數量

pos_81_90
類型: integer | null

網域或子網域排名第 81-90 名的自然 SERP 數量

pos_91_100
類型: integer | null

網域或子網域排名第 91-100 名的自然 SERP 數量

month
類型: integer | null

資料所屬的月份

se_type
類型: string | null

搜尋引擎類型

year
類型: integer | null

資料所屬的年份

items_count
類型: integer | null 格式: int64

items 陣列中傳回的結果數

language_code
類型: string | null

POST 陣列中的語言代碼

location_code
類型: integer | null

POST 陣列中的位置代碼

se_type
類型: string | null

搜尋引擎類型

target
類型: string | null

POST 陣列中的目標網域

total_count
類型: integer | null 格式: int64

我們資料庫中與你的請求相關的結果總數

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/dataforseo_labs/google/historical_rank_overview/live

curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/historical_rank_overview/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": "dataforseo.com",
    "location_code": 2840,
    "language_code": "en",
    "date_from": "2021-01-01",
    "date_to": "2021-03-29"
  }
]'

顯示 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": [
        {
          "se_type": null,
          "target": null,
          "location_code": null,
          "language_code": null,
          "total_count": null,
          "items_count": null,
          "items": [
            {
              "se_type": null,
              "year": null,
              "month": null,
              "metrics": null
            }
          ]
        }
      ]
    }
  ]
}

操作成功

需要協助嗎？

API、帳務或帳號問題，請聯絡支援。
在 Discord 上與 Felo 開發者交流。
查看我們的更新日誌。
需要大量授權或採購協助？聯絡業務。
正在用 LLM 開發？閱讀 llms.txt。

歷史排名概覽

身分驗證Required

DataForSEO

歷史排名概覽

計費參考

需要協助嗎？