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/keywords_for_site/live

網站關鍵字

target 網站取得排名的關鍵字。回傳 se_type、target、total_count、offset_token 與 items。分頁使用 limit、offset 與 offset_token；超過前幾頁後請改用該權杖。採用 DataForSEO 的信封結構：資料位於 tasks[0].result，結果狀態位於 tasks[0].status_code——被拒絕的請求仍會回傳 HTTP 200。這是同一個問題，只是改為分頁回傳，價格僅為其七分之一。

計費參考

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

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

請求本文

application/json

類型: array (object | null)[]
- filters
  類型: array (object | null)[] | null
  
  結果篩選參數陣列
  選填欄位
  可同時新增多個篩選條件（最多 8 個）
  應在條件之間設定邏輯運算子 and、or
  支援以下運算子：
  regex、not_regex、<、<=、>、>=、=、<>、in、not_in、match、not_match、ilike、not_ilike、like、not_like
  可在 like 與 not_like 以及 ilike 與 not_ilike 中使用 % 運算子，比對任意長度（零個或多個字元）的字串
  注意，無法依 relevance 篩選結果
  範例：
  ["keyword_info.search_volume",">",0]
  有關篩選條件的更多資訊，請參閱 Dataforseo Labs - Filters 或這篇說明中心指南
  
  空物件
- include_clickstream_data
  類型: boolean | null
  
  在結果中包含或排除以點擊流為基礎的指標資料
  選填欄位
  如果參數設為 true，回應中將包含 clickstream_keyword_info、keyword_info_normalized_with_clickstream 與 keyword_info_normalized_with_bing 欄位
  預設值：false
  啟用此參數後，該請求將以雙倍價格計費
  
  有關以點擊流為基礎的指標如何計算的更多資訊，請參閱這篇說明中心文章
- include_serp_info
  類型: boolean | null
  
  包含每個關鍵字的 SERP 資料
  選填欄位
  如果設為 true，我們將傳回一個 serp_info 陣列，其中包含回應中每個關鍵字的 SERP 資料（搜尋結果數量、相關 URL 與 SERP 功能）
  預設值：false
- include_subdomains
  類型: boolean | null
  
  指示搜尋中是否包含子網域
  選填欄位
  如果設為 false，子網域將被忽略
  預設值：true
- language_code
  類型: string | null
  
  語言代碼
  選填欄位
  如果使用此欄位，則無需指定 language_name
  可個別向
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages 發出請求，取得可用語言及其 language_code 的清單
  範例：
  en
  注意：省略此欄位時，結果將預設使用指定地點中關鍵字記錄最多的語言；
  請參考 Locations and Languages 端點的 available_languages.keywords 欄位來判斷預設語言
- language_name
  類型: string | null
  
  語言全名
  選填欄位
  如果使用此欄位，則無需指定 language_code
  可個別向
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages 發出請求，取得可用語言及其 language_name 的清單
  範例：
  English
  注意：省略此欄位時，結果將預設使用指定地點中關鍵字記錄最多的語言；
  請參考 Locations and Languages 端點的 available_languages.keywords 欄位來判斷預設語言
- limit
  類型: integer | null
  
  結果陣列中關鍵字的最大數量
  選填欄位
  預設值：100
  最大值：1000
- 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
- offset
  類型: integer | null
  
  傳回的關鍵字在結果陣列中的位移量
  選填欄位
  預設值：0
  若指定 10，結果陣列中的前 10 個關鍵字將被略過，並傳回後續關鍵字的資料
  注意：建議僅在擷取最多 10,000 筆結果時使用此參數
  如需擷取超過 10,000 筆結果，請改用 offset_token。
- offset_token
  類型: string | null
  
  用於後續請求的位移權杖
  選填欄位
  在每次請求回應的同名欄位中提供；
  使用此參數可在單次請求嘗試取得超過 10,000 筆結果時避免逾時；
  透過指定回應陣列中的唯一 offset_token 值，你將取得初始任務的後續結果；
  offset_token 值對每個後續任務都是唯一的
  注意：如果請求中指定了 offset_token，處理任務時將不考慮除 limit 之外的所有其他參數。
  如需進一步瞭解此參數，請參閱我們的說明中心
- order_by
  類型: array string[] | null
  
  結果排序規則
  選填欄位
  可使用與 filters 陣列相同的值排序結果
  可能的排序類型：
  asc - 結果將依遞增順序排列
  desc - 結果將依遞減順序排列
  應使用逗號設定排序參數
  
  預設規則：
  ["relevance,desc"]
  relevance 用作預設排序規則，以提供最接近的關鍵字建議。我們建議使用此排序規則來取得高度相關的搜尋詞。注意，relevance 只是我們的內部系統識別碼，因此不能用作篩選條件，你也不會在 result 陣列中看到此欄位。相關性評分的基本原理與 Keywords For Keywords 端點相同。請注意，單次請求中最多可設定三條排序規則
  應使用逗號分隔多條排序規則
  範例：
  ["relevance,desc","keyword_info.search_volume,desc"]
- tag
  類型: string | null
  
  使用者自訂任務識別碼
  選填欄位
  字元數上限為 255
  可使用此參數識別任務，並將其與結果對應
  可在回應的 data 物件中找到指定的 tag 值
- target
  類型: string
  
  網域名稱或頁面 URL
  必填欄位
  目標網站的網域名稱、子網域或目標網頁的 URL；
  網域名稱必須不含 https:// 或 www.；
  子網域必須不含 https://；
  網頁 URL必須包含 https:// 或 www.
  注意：如果指定的網頁 URL不含 https:// 或 www.，結果將針對整個網域而非特定頁面傳回

回應

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

任務總費用，美元

status_code
類型: integer | null

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

status_message
類型: string | null

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

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

任務陣列

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

包含關鍵字構想及相關資料

avg_backlinks_info
類型: object | null · Response36Afe1097B20_AvgBacklinksInfo

傳回關鍵字的反向連結資料
此物件提供平均反向連結數、引用頁面數與網域數，以及該關鍵字自然排名前 10 網站的平均排名值

backlinks
類型: number | null

平均反向連結數

dofollow
類型: number | null

平均 dofollow 連結數

last_updated_time
類型: string | null

關鍵字資料更新的日期與時間
採用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”
範例：
2019-11-15 12:57:46 +00:00

main_domain_rank
類型: number | null

平均主要網域排名
在這篇說明中心文章中進一步瞭解此指標及其計算公式

rank
類型: number | null

平均排名
如需進一步瞭解該指標及其計算方式，請參閱這篇說明中心文章

referring_domains
類型: number | null

平均引薦網域數量

referring_main_domains
類型: number | null

平均引薦主網域數量

referring_pages
類型: number | null

平均引薦頁面數量

se_type
類型: string | null

搜尋引擎類型

clickstream_keyword_info
類型: object | null · Response36Afe1097B20_ClickstreamKeywordInfo

傳回關鍵字的點擊流資料
若要取得此欄位的結果，參數 include_clickstream_data 必須設為 true

age_distribution
類型: object | null

依年齡分佈的點擊流指標
如需瞭解該指標的計算方式，請參閱這篇說明中心文章

propertyName
類型: integer | null 格式: int64

Signed 64-bit integers (long type).

gender_distribution
類型: object | null

依性別分佈的點擊流估算指標
如需瞭解該指標的計算方式，請參閱這篇說明中心文章

propertyName
類型: integer | null 格式: int64

Signed 64-bit integers (long type).

last_updated_time
類型: string | null

關鍵字資料更新的日期與時間
採用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”
範例：
2019-11-15 12:57:46 +00:00

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

每月搜尋量
表示該關鍵字概念在指定地理位置的（約略）搜尋次數（根據過去十二個月的資料）

month
類型: integer | null

月

search_volume
類型: integer | null

每月平均搜尋量

year
類型: integer | null

年

search_volume
類型: integer | null 格式: int64

平均每月搜尋量
表示該關鍵字概念在 google.com 上的（約略）搜尋次數

keyword
類型: string | null

傳回的關鍵字想法

keyword_info
類型: object | null · Response36Afe1097B20_KeywordInfo

傳回關鍵字想法的關鍵字資料

categories
類型: array integer[] | null

產品與服務類別
你可以下載所有可能類別的完整清單

competition
類型: number | null

競爭
代表與指定關鍵字相關的相對競爭程度。此值根據 Google Ads 資料，介於 0 與 1 之間（含 0 與 1）

competition_level
類型: string | null

競爭程度
僅代表指定關鍵字在付費 SERP 中的相對競爭程度；
可能的值：LOW、MEDIUM、HIGH
若競爭程度未知，該值為 null；
在這篇說明中心文章中進一步瞭解此指標

cpc
類型: number | null

每次點擊費用
代表該關鍵字歷來平均每次點擊費用（美元）

high_top_of_page_bid
類型: number | null

廣告顯示於首頁頂端的最高出價
代表高於約 80% 廣告得以顯示之最低出價的值（根據 Google Ads 的廣告主統計資料）
此值可能因 POST 請求中指定的地點而異

last_updated_time
類型: string | null

關鍵字資料更新的日期與時間
採用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”
範例：
2019-11-15 12:57:46 +00:00

low_top_of_page_bid
類型: number | null

廣告顯示於首頁頂端的最低出價
代表高於約 20% 廣告得以顯示之最低出價的值（根據 Google Ads 的廣告主統計資料）
此值可能因 POST 請求中指定的地點而異

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

每月搜尋量
表示該關鍵字概念在指定地理位置的（約略）搜尋次數（根據過去十二個月的資料）

month
類型: integer | null

月

search_volume
類型: integer | null

每月平均搜尋量

year
類型: integer | null

年

se_type
類型: string | null

搜尋引擎類型

search_volume
類型: integer | null 格式: int64

平均每月搜尋量
表示該關鍵字概念在 google.com 上的（約略）搜尋次數

search_volume_trend
類型: object | null · Response36Afe1097B20_SearchVolumeTrend

搜尋量趨勢變化
代表與上一期間相比的搜尋量變化百分比

monthly
類型: integer | null

搜尋量相較上個月的百分比變化

quarterly
類型: integer | null

搜尋量相較上一季的百分比變化

yearly
類型: integer | null

搜尋量相較去年的百分比變化

keyword_info_normalized_with_bing
類型: object | null · Response36Afe1097B20_KeywordInfoNormalizedWithInfo

包含以 Bing 搜尋量標準化的關鍵字搜尋量

is_normalized
類型: boolean | null

關鍵字資訊已正規化若為 true，數值會使用 Bing 資料正規化

last_updated_time
類型: string | null

資料集更新日期與時間 UTC 格式：「yyyy-mm-dd hh-mm-ss +00:00」範例： 2019-11-15 12:57:46 +00:00

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

每月搜尋量物件陣列，包含一年中某個月的搜尋量

month
類型: integer | null

月

search_volume
類型: integer | null

每月平均搜尋量

year
類型: integer | null

年

search_volume
類型: integer | null

關鍵字的目前搜尋量

keyword_info_normalized_with_clickstream
類型: object | null · Response36Afe1097B20_KeywordInfoNormalizedWithInfo

包含以點擊流資料標準化的關鍵字搜尋量

is_normalized
類型: boolean | null

關鍵字資訊已正規化若為 true，數值會使用 Bing 資料正規化

last_updated_time
類型: string | null

資料集更新日期與時間 UTC 格式：「yyyy-mm-dd hh-mm-ss +00:00」範例： 2019-11-15 12:57:46 +00:00

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

每月搜尋量物件陣列，包含一年中某個月的搜尋量

month
類型: integer | null

月

search_volume
類型: integer | null

每月平均搜尋量

year
類型: integer | null

年

search_volume
類型: integer | null

關鍵字的目前搜尋量

keyword_properties
類型: object | null · Response36Afe1097B20_KeywordProperties

關鍵字的額外資訊

core_keyword
類型: string | null

群組中的主關鍵字
包含由同義字叢集演算法決定的群組主關鍵字
若值為 null，表示我們的資料庫中沒有對應演算法可辨識為與 keyword 同義的關鍵字

detected_language
類型: string | null

偵測到的關鍵字語言
代表系統辨識出的關鍵字語言

is_another_language
類型: boolean | null

偵測到的關鍵字語言與設定的語言不同
若為 true，表示請求中設定的語言與系統為指定關鍵字判定的語言不一致

keyword_difficulty
類型: integer | null

關鍵字進入前 10 個自然搜尋結果排名的難度
代表關鍵字進入前 10 個自然搜尋結果的機會，採用 0 到 100 的對數刻度；
計算時會分析 SERP 前 10 個頁面的連結概況等參數；
在這篇說明中心指南中進一步瞭解此指標

se_type
類型: string | null

搜尋引擎類型

synonym_clustering_algorithm
類型: string | null

用於辨識同義字的演算法
可能的值：
keyword_metrics - 表示以 keyword_info 參數為基礎的演算法
text_processing - 表示以文字為基礎的演算法
若值為 null，表示我們的資料庫中沒有對應演算法可辨識為與 keyword 同義的關鍵字

words_count
類型: integer | null 格式: int64

關鍵字中的字數
表示該關鍵字由多少個詞組成

language_code
類型: string | null

POST 陣列中的語言代碼

location_code
類型: integer | null

POST 陣列中的位置代碼

se_type
類型: string | null

搜尋引擎類型

search_intent_info
類型: object | null · Response36Afe1097B20_SearchIntentInfo

傳回關鍵字的搜尋意圖資訊
可於這篇說明中心文章中瞭解搜尋意圖

foreign_intent
類型: array (string | null)[] | null

補充搜尋意圖
可能的值：informational、navigational、commercial、transactional

last_updated_time
類型: string | null

關鍵字資料更新的日期與時間
採用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”
範例：
2019-11-15 12:57:46 +00:00

main_intent
類型: string | null

主要搜尋意圖
可能的值：informational、navigational、commercial、transactional

se_type
類型: string | null

搜尋引擎類型

serp_info
類型: object | null · Response36Afe1097B20_SerpInfo

SERP 資料
此值為 null 的情況包括：未在 POST 陣列中將 include_serp_info 設為 true，或我們的資料庫中沒有此關鍵字的 SERP 資料

check_url
類型: string | null

搜尋引擎結果的直接 URL
可用來確認我們提供了準確的結果

last_updated_time
類型: string | null

關鍵字資料更新的日期與時間
採用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”
範例：
2019-11-15 12:57:46 +00:00

previous_updated_time
類型: string | null

SERP 資料在最近一次更新之前的日期與時間
採用 UTC 格式：“yyyy-mm-dd hh-mm-ss +00:00”
範例：
2019-10-15 12:57:46 +00:00

se_results_count
類型: integer | null 格式: int64

傳回關鍵字的搜尋結果數

se_type
類型: string | null

搜尋引擎類型

serp_item_types
類型: array (string | null)[] | null

SERP 中的搜尋結果類型
包含在 SERP 中找到的搜尋結果類型（items）
可能的項目類型：
answer_box、app、carousel、multi_carousel、featured_snippet、google_flights、google_reviews、third_party_reviews、google_posts、images、jobs、knowledge_graph、local_pack、hotels_pack、map、organic、paid、people_also_ask、related_searches、people_also_search、shopping、top_stories、twitter、video、events、mention_carousel、recipes、top_sights、scholarly_articles、popular_products、podcasts、questions_and_answers、find_results_on、stocks_box、visual_stories、commercial_units、local_services、google_hotels、math_solver、currency_box、product_considerations、found_on_web、short_videos、refine_products、explore_brands、perspectives、discussions_and_forums、compare_sites、courses、ai_overview；
注意，實際結果僅針對 organic、paid、featured_snippet 與 local_pack 元素傳回

items_count
類型: integer | null 格式: int64

items 陣列中傳回的結果數

language_code
類型: string | null

POST 陣列中的語言代碼

location_code
類型: integer | null

POST 陣列中的位置代碼

offset
類型: integer | null

目前的位移值

offset_token
類型: string | null

供後續請求使用的偏移權杖
可使用此欄位提供的字串取得初始任務的後續結果；
注意：offset_token 的值對每個後續任務都是唯一的

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/keywords_for_site/live

curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/keywords_for_site/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": "apple.com",
    "language_code": "en",
    "location_code": 2840,
    "include_serp_info": true,
    "include_subdomains": true,
    "filters": [
      "serp_info.se_results_count",
      ">",
      0
    ],
    "limit": 3
  }
]'

顯示 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,
          "offset": null,
          "offset_token": null,
          "items": [
            {
              "se_type": null,
              "keyword": null,
              "location_code": null,
              "language_code": null,
              "keyword_info": "[Max Depth Exceeded]",
              "keyword_info_normalized_with_bing": "[Max Depth Exceeded]",
              "keyword_info_normalized_with_clickstream": "[Max Depth Exceeded]",
              "clickstream_keyword_info": "[Max Depth Exceeded]",
              "keyword_properties": "[Max Depth Exceeded]",
              "serp_info": "[Max Depth Exceeded]",
              "avg_backlinks_info": "[Max Depth Exceeded]",
              "search_intent_info": "[Max Depth Exceeded]"
            }
          ]
        }
      ]
    }
  ]
}

操作成功

需要協助嗎？

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

網站關鍵字

身分驗證Required

DataForSEO

網站關鍵字

計費參考

需要協助嗎？