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

计费参考

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

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

请求体

application/json

类型: array (object | null)[]
- filters
  类型: array (object | null)[] | null
  
  结果筛选参数数组
  可选字段
  可同时添加多个筛选条件（最多 8 个）
  应在条件之间设置逻辑运算符 and、or
  支持以下运算符：
  regex、not_regex、<、<=、>、>=、=、<>、in、not_in
  
  示例：
  ["metrics.paid.count",">",0]
  
  [["metrics.organic.count",">",50],"and",["metrics.organic.pos_1","<>",0]]
  
  [[""metrics.organic.count",">",50"], "and", [["metrics.organic.pos_1","<>",0],"or",["metrics.organic.pos_2_3","<>",0]]]
  有关筛选条件的更多信息，请参阅 Dataforseo Labs - Filters 或这篇帮助中心指南
  
  空对象
- historical_serp_mode
  类型: string | null
  
  数据收集模式
  可选字段
  可使用此字段筛选结果；
  可能的筛选类型：
  live — 返回指定 target 当前有排名结果的 SERP 指标；
  lost — 返回指定 target 此前曾有排名结果、但在最近一次检查中没有排名结果的 SERP 指标；
  all — 返回两种 SERP 的指标。
  默认值：live
- ignore_synonyms
  类型: boolean | null
  
  忽略高度相似的关键词
  可选字段
  如果设为 true，则只返回核心关键词，所有高度相似的关键词都将被排除；
  默认值：false
- include_clickstream_data
  类型: boolean | null
  
  在结果中包含或排除基于点击流的指标数据
  可选字段
  如果参数设为 true，响应中将包含带有点击流数据的 clickstream_etv、clickstream_gender_distribution 和 clickstream_age_distribution 字段
  默认值：false
  启用此参数后，该请求将按双倍价格计费
  
  有关基于点击流的指标如何计算的更多信息，请参阅这篇帮助中心文章
- item_types
  类型: array string[] | null
  
  按项目类型显示结果
  可选字段
  指示响应中包含的搜索结果类型
  
  注意：如果 item_types 数组包含与 organic 不同的项目类型，结果将按数组中的第一个项目类型排序；你无法按响应中未包含的搜索结果类型对结果排序和筛选；
  
  可能的值：
  ["organic", "paid", "featured_snippet", "local_pack"]
  默认值：
  ["organic", "paid"]
- language_code
  类型: string | null
  
  语言代码
  可选字段
  如果使用此字段，则无需指定 language_name
  可单独向
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages 发起请求，获取可用语言及其 language_code 的列表
  忽略此字段可获取所有可用语言的结果
  示例：
  en
- language_name
  类型: string | null
  
  语言全名
  可选字段
  如果使用此字段，则无需指定 language_code
  可单独向
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages 发起请求，获取可用语言及其 language_name 的列表
  忽略此字段可获取所有可用语言的结果
  示例：
  English
- limit
  类型: integer | null
  
  返回页面的最大数量
  可选字段
  默认值：100
  最大值：1000
- location_code
  类型: integer | null
  
  地点代码
  可选字段
  如果使用此字段，则无需指定 location_name
  可单独向
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages 发起请求，获取可用地点及其 location_code 的列表
  忽略此字段可获取所有可用地点的结果
  示例：
  2840
- location_name
  类型: string | null
  
  地点全名
  可选字段
  如果使用此字段，则无需指定 location_code
  可单独向
  https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages 发起请求，获取可用地点及其 location_name 的列表
  忽略此字段可获取所有可用地点的结果
  示例：
  United Kingdom
- offset
  类型: integer | null
  
  返回的页面在结果数组中的偏移量
  可选字段
  默认值：0
  如果指定 10，结果数组中的前十个页面将被跳过，并返回后续页面的数据
- order_by
  类型: array string[] | null
  
  结果排序规则
  可选字段
  可使用与 filters 数组相同的值对结果排序
  可能的排序类型：
  asc - 结果将按升序排列
  desc - 结果将按降序排列
  应使用逗号指定排序类型
  示例：
  ["metrics.paid.etv,asc"]
  注意：单次请求中最多可设置三条排序规则
  应使用逗号分隔多条排序规则
  示例：
  ["metrics.organic.etv,desc","metrics.paid.count,asc"]
  
  默认规则：
  ["metrics.organic.count,desc"]
  注意：如果 item_types 数组包含与 organic 不同的项目类型，结果将按数组中的第一个项目类型排序
- tag
  类型: string | null
  
  用户自定义任务标识符
  可选字段
  字符数上限为 255
  可使用此参数标识任务，并将其与结果对应
  可在响应的 data 对象中找到指定的 tag 值
- target
  类型: string
  
  域名
  必填字段
  目标网站的域名
  域名不应包含 https:// 和 www.

响应

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

任务总费用，美元

status_code
类型: integer | null

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

status_message
类型: string | null

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

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

任务数组

类型: object | null · Response36Afe1097B20_DataforseoLabsGoogleRelevantPagesLiveTaskInfo
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 数量

page_address
类型: string | null

相关页面的绝对 URL

se_type
类型: string | null

搜索引擎类型

items_count
类型: integer | null 格式: int64

items 数组中返回的结果数

language_code
类型: string | null

POST 数组中的语言代码
若没有数据，则该值为 null

location_code
类型: integer | null

POST 数组中的地点代码
若没有数据，则该值为 null

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

curl https://openapi.felo.ai/v1/beta/dataforseo/dataforseo_labs/google/relevant_pages/live \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '[
  {
    "target": "amazon.com",
    "language_name": "English",
    "location_code": 2840,
    "filters": [
      [
        "metrics.organic.pos_1",
        "<>",
        0
      ],
      "or",
      [
        "metrics.organic.pos_2_3",
        "<>",
        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,
          "items": [
            {
              "se_type": null,
              "page_address": null,
              "metrics": null
            }
          ]
        }
      ]
    }
  ]
}

操作成功

需要帮助？

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

相关页面

身份验证Required

DataForSEO

相关页面

计费参考

需要帮助？