> ## Documentation Index
> Fetch the complete documentation index at: https://aisa.one/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 历史排名概览

> 此端点将提供指定域名的历史排名和流量数据，例如域名在 SERP 中的排名分布和估算...



## OpenAPI

````yaml openapi/zh/dataforseo.json POST /dataforseo/dataforseo_labs/google/historical_rank_overview/live
openapi: 3.0.3
info:
  title: DataForSEO API
  version: 1.0.0
  description: 通过 AIsa 统一网关提供的 DataForSEO API 端点。
servers:
  - url: https://api.aisa.one/apis/v1
security:
  - BearerAuth: []
paths:
  /dataforseo/dataforseo_labs/google/historical_rank_overview/live:
    post:
      summary: 历史排名概览
      description: 此端点将提供指定域名的历史排名和流量数据，例如该域名在 SERP 中的排名分布，以及自然搜索结果和付费搜索结果的预估月流量。
      operationId: post_dataforseo_dataforseo_labs_google_historical_rank_overview_live
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                target:
                  type: string
                  description: domain 必填字段，目标网站的域名；指定域名时不应包含 https:// 和 www.
                location_name:
                  type: string
                  description: >-
                    位置的完整名称；未指定 location_code 时为必填字段。注意：必须指定 location_name 或
                    location_code 之一。您可以通过向
                    https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
                    单独发送请求，获取包含 location_name 的可用位置列表；示例：United Kingdom
                location_code:
                  type: integer
                  description: >-
                    位置代码；如果未指定 location_name，则为必填字段。注意：必须指定 location_name 或
                    location_code 其中之一；可通过向
                    https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
                    单独发起请求，获取可用位置及其 location_code 的列表；示例：2840
                language_name:
                  type: string
                  description: >-
                    语言的完整名称 如果未指定 language_code，则为必填字段 注意：必须指定 language_name 或
                    language_code 之一 可以通过向
                    https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
                    单独发送请求，获取包含 language_name 的可用位置列表 示例：English
                language_code:
                  type: string
                  description: >-
                    语言代码；如果未指定 language_name，则此字段为必填字段。注意：必须指定 language_name 或
                    language_code 之一。您可以通过向
                    https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
                    单独发送请求，获取可用位置及其 language_code 的列表。示例：en
                date_from:
                  type: string
                  description: >-
                    时间范围的起始日期。可选字段；如果未指定此字段，将提供前 6
                    个月的数据。最小可用值：2020-10-01。日期格式："yyyy-mm-dd"
                date_to:
                  type: string
                  description: >-
                    时间范围的结束日期，可选字段。如果未指定此字段，则默认使用今天的日期。日期格式："yyyy-mm-dd"，示例："2021-04-01"
                correlate:
                  type: boolean
                  description: >-
                    将数据与之前获取的数据集关联；可选字段；默认值：true；如果使用此参数，系统会将当前获取的数据与之前获取的数据集关联；此参数旨在减少数据库变更可能导致的任何不一致；建议始终将
                    correlate 设置为 true
                ignore_synonyms:
                  type: boolean
                  description: >-
                    忽略高度相似的关键词，可选字段；如果设置为
                    true，则仅返回基于核心关键词的数据，并排除所有高度相似关键词的数据；默认值：false
                include_clickstream_data:
                  type: boolean
                  description: >-
                    在结果中包含或排除基于点击流的指标数据，可选字段。如果将该参数设置为 true，响应中将包含带有点击流数据的
                    clickstream_etv、clickstream_gender_distribution 和
                    clickstream_age_distribution 字段；默认值：false。注意：历史点击流数据从
                    2024/05（2024 年 5
                    月）起可用；启用此参数后，该请求将按双倍价格收费；有关基于点击流的指标如何计算的更多信息，请参阅此帮助中心文章
                tag:
                  type: string
                  description: >-
                    用户定义的任务标识符。可选字段。字符数限制为 255。您可以使用此参数标识任务并将其与结果匹配；您将在响应的 data
                    对象中找到指定的 tag 值
              required:
                - target
                - location_name
                - location_code
                - language_name
                - language_code
      responses:
        '200':
          description: 成功响应
          content:
            application/json:
              schema:
                type: object
                properties:
                  version:
                    type: string
                    description: API 的当前版本
                  status_code:
                    type: integer
                    description: 通用状态码；您可以在此处查看完整的响应码列表。注意：我们强烈建议设计必要的系统来处理相关异常或错误情况
                  status_message:
                    type: string
                    description: 常规信息消息；可在此处查看常规信息消息的完整列表
                  time:
                    type: string
                    description: 执行时间（秒）
                  cost:
                    type: number
                    description: 任务总成本（美元）
                  tasks_count:
                    type: integer
                    description: tasks 数组中的任务数量
                  tasks_error:
                    type: integer
                    description: 返回错误的 tasks 数组中的任务数量
                  tasks:
                    type: array
                    items:
                      type: string
                    description: 任务数组
                  tasks.id:
                    type: string
                    description: 任务标识符，系统中采用 UUID 格式的唯一任务标识符
                  tasks.status_code:
                    type: integer
                    description: DataForSEO 生成的任务状态码；范围为：10000-60000；完整响应代码列表可在此处查看
                  tasks.status_message:
                    type: string
                    description: 任务的信息性消息，你可以在此处查看通用信息性消息的完整列表
                  tasks.time:
                    type: string
                    description: 执行时间（秒）
                  tasks.cost:
                    type: number
                    description: 任务成本（美元）
                  tasks.result_count:
                    type: integer
                    description: 结果数组中的元素数量
                  tasks.path:
                    type: array
                    items:
                      type: string
                    description: URL 路径
                  tasks.data:
                    type: object
                    description: 包含您在 POST 请求中指定的相同参数
                  tasks.result:
                    type: array
                    items:
                      type: string
                    description: 结果数组
                  tasks.result.se_type:
                    type: string
                    description: 搜索引擎类型
                  tasks.result.target:
                    type: string
                    description: POST 数组中的目标域名
                  tasks.result.location_code:
                    type: integer
                    description: POST 数组中的位置代码
                  tasks.result.language_code:
                    type: string
                    description: POST 数组中的语言代码
                  tasks.result.total_count:
                    type: integer
                    description: 数据库中与您的请求相关的结果总量
                  tasks.result.items_count:
                    type: integer
                    description: items 数组中返回的结果数量
                  tasks.result.items:
                    type: array
                    items:
                      type: string
                    description: 包含历史排名和流量数据
                  tasks.result.items.se_type:
                    type: string
                    description: 搜索引擎类型
                  tasks.result.items.year:
                    type: integer
                    description: 所提供数据对应的年份
                  tasks.result.items.month:
                    type: integer
                    description: 数据对应的月份
                  tasks.result.items.metrics:
                    type: object
                    description: 与指定域名相关的排名数据
                  tasks.result.items.metrics.organic:
                    type: object
                    description: 自然搜索的排名和流量数据
                  tasks.result.items.metrics.organic.pos_1:
                    type: integer
                    description: '域名排名第 #1 的自然搜索 SERP 数量'
                  tasks.result.items.metrics.organic.pos_2_3:
                    type: integer
                    description: 域名自然搜索结果排名第 2–3 位的数量
                  tasks.result.items.metrics.organic.pos_4_10:
                    type: integer
                    description: 域名排名第 4-10 位的自然搜索结果页数量
                  tasks.result.items.metrics.organic.pos_11_20:
                    type: integer
                    description: 域名排名第 11-20 位的自然搜索结果页数量
                  tasks.result.items.metrics.organic.pos_21_30:
                    type: integer
                    description: 域名排名第 21-30 位的自然搜索结果页数量
                  tasks.result.items.metrics.organic.pos_31_40:
                    type: integer
                    description: 域名排名第 31-40 位的自然搜索结果页数量
                  tasks.result.items.metrics.organic.pos_41_50:
                    type: integer
                    description: 域名排名第 41–50 位的自然搜索结果页数量
                  tasks.result.items.metrics.organic.pos_51_60:
                    type: integer
                    description: 域名排名第 51–60 位的自然搜索结果页数量
                  tasks.result.items.metrics.organic.pos_61_70:
                    type: integer
                    description: '域名排名第 #61-70 位的自然搜索结果数量'
                  tasks.result.items.metrics.organic.pos_71_80:
                    type: integer
                    description: 域名排名第 71-80 位的自然搜索结果页数量
                  tasks.result.items.metrics.organic.pos_81_90:
                    type: integer
                    description: 该域名排名第 81-90 位的自然搜索 SERP 数量
                  tasks.result.items.metrics.organic.pos_91_100:
                    type: integer
                    description: 该域名排名第 91-100 位的自然搜索 SERP 数量
                  tasks.result.items.metrics.organic.etv:
                    type: number
                    description: >-
                      预估流量 域名的预估自然搜索月流量，计算方式为该域名参与排名的所有关键词的
                      CTR（点击率）与搜索量之乘积的总和；有关此指标计算方式的更多信息，请参阅此帮助中心文章
                  tasks.result.items.metrics.organic.count:
                    type: integer
                    description: 包含该域名的自然搜索 SERP 总数
                  tasks.result.items.metrics.organic.estimated_paid_traffic_cost:
                    type: number
                    description: >-
                      将自然搜索流量转化为付费流量的估算成本，表示为某个域名有排名的所有关键词投放广告的估算每月成本（USD）；该指标通过
                      organic etv 与 paid cpc 值的乘积计算，表示通过 Google Search 中的 PPC
                      广告获得估算每月自然流量所需的成本。有关该指标如何计算的更多信息，请参阅此帮助中心文章
                  tasks.result.items.metrics.organic.is_new:
                    type: integer
                    description: 新排名元素的数量，表示为指定目标发现了多少个新排名元素
                  tasks.result.items.metrics.organic.is_up:
                    type: integer
                    description: 排名上升，表示指定目标中排名上升的元素数量
                  tasks.result.items.metrics.organic.is_down:
                    type: integer
                    description: 排名下降 表示指定目标中排名下降的元素数量
                  tasks.result.items.metrics.organic.is_lost:
                    type: integer
                    description: 丢失的排名元素；表示所指目标中有多少排名元素此前曾出现在 SERP 中，但在最近一次检查时未被发现
                  tasks.result.items.metrics.organic.clickstream_etv:
                    type: integer
                    description: >-
                      基于点击流数据估算的流量，即该域名获得排名的所有关键词的点击率与点击流搜索量乘积之和 要获取此字段的结果，必须将参数
                      include_clickstream_data 设置为 true
                      有关此指标计算方式的更多信息，请参阅此帮助中心文章
                  tasks.result.items.metrics.organic.clickstream_gender_distribution:
                    type: object
                    description: >-
                      按性别划分的基于估算点击流的指标分布；要检索此字段的结果，参数 include_clickstream_data
                      必须设置为 true；有关该指标计算方式的更多信息，请参阅此帮助中心文章
                  tasks.result.items.metrics.organic.female:
                    type: integer
                    description: 相关点击流数据集中的女性用户数量
                  tasks.result.items.metrics.organic.male:
                    type: integer
                    description: 相关点击流数据集中的男性用户数量
                  tasks.result.items.metrics.organic.clickstream_age_distribution:
                    type: object
                    description: >-
                      按年龄划分的基于点击流的指标分布。要检索此字段的结果，必须将参数 include_clickstream_data
                      设置为 true。有关该指标计算方式的更多信息，请参阅此帮助中心文章
                  tasks.result.items.metrics.organic.18-24:
                    type: integer
                    description: 相关点击流数据集中年龄在 18 至 24 岁范围内的用户数量
                  tasks.result.items.metrics.organic.25-34:
                    type: integer
                    description: 相关点击流数据集中年龄在 25-34 岁范围内的用户数量
                  tasks.result.items.metrics.organic.35-44:
                    type: integer
                    description: 相关点击流数据集中年龄在 35-44 岁范围内的用户数量
                  tasks.result.items.metrics.organic.45-54:
                    type: integer
                    description: 相关点击流数据集中年龄在 45-54 岁范围内的用户数量
                  tasks.result.items.metrics.organic.55-64:
                    type: integer
                    description: 相关点击流数据集中年龄在 55-64 岁范围内的用户数量
                  tasks.result.items.metrics.paid:
                    type: object
                    description: 付费搜索的排名和流量数据
                  tasks.result.items.metrics.paid.pos_1:
                    type: integer
                    description: 该域名排名第 1 的付费 SERP 数量
                  tasks.result.items.metrics.paid.pos_2_3:
                    type: integer
                    description: '域名排名第 #2-3 位的付费 SERP 数量'
                  tasks.result.items.metrics.paid.pos_4_10:
                    type: integer
                    description: '域名排名第 #4-10 位的付费 SERP 数量'
                  tasks.result.items.metrics.paid.pos_11_20:
                    type: integer
                    description: '域名排名第 #11-20 位的付费 SERP 数量'
                  tasks.result.items.metrics.paid.pos_21_30:
                    type: integer
                    description: 该域名在付费 SERP 中排名第 21-30 位的数量
                  tasks.result.items.metrics.paid.pos_31_40:
                    type: integer
                    description: '域名排名第 #31-40 位的付费 SERP 数量'
                  tasks.result.items.metrics.paid.pos_41_50:
                    type: integer
                    description: '域名排名第 #41-50 位的付费 SERP 数量'
                  tasks.result.items.metrics.paid.pos_51_60:
                    type: integer
                    description: 域名在付费搜索结果页中排名第 51-60 位的数量
                  tasks.result.items.metrics.paid.pos_61_70:
                    type: integer
                    description: '域名排名第 #61-70 位的付费 SERP 数量'
                  tasks.result.items.metrics.paid.pos_71_80:
                    type: integer
                    description: '域名排名第 #71-80 位的付费 SERP 数量'
                  tasks.result.items.metrics.paid.pos_81_90:
                    type: integer
                    description: 域名排名第 81-90 位的付费搜索结果页数量
                  tasks.result.items.metrics.paid.pos_91_100:
                    type: integer
                    description: 域名在付费搜索结果中排名第 91-100 位的 SERP 数量
                  tasks.result.items.metrics.paid.etv:
                    type: number
                    description: >-
                      预估流量：域名的预估每月付费流量，计算方式为该域名排名涉及的所有关键词的
                      CTR（点击率）与搜索量之积；有关此指标计算方式的更多信息，请参阅此帮助中心文章
                  tasks.result.items.metrics.paid.count:
                    type: integer
                    description: 包含该域名的付费 SERP 总数
                  tasks.result.items.metrics.paid.estimated_paid_traffic_cost:
                    type: number
                    description: >-
                      每月搜索流量的预估成本。表示根据 etv 和 cpc
                      值估算的每月付费流量成本（USD）。有关该指标计算方式的更多信息，请参阅此帮助中心文章
                  tasks.result.items.metrics.paid.is_new:
                    type: integer
                    description: 新排名元素的数量，表示为指定目标发现了多少个新排名元素
                  tasks.result.items.metrics.paid.is_up:
                    type: integer
                    description: 排名上升，表示指定目标中排名上升的元素数量
                  tasks.result.items.metrics.paid.is_down:
                    type: integer
                    description: 排名下降 表示指定目标中排名下降的元素数量
                  tasks.result.items.metrics.paid.is_lost:
                    type: integer
                    description: 丢失的排名元素；表示所指目标中有多少排名元素此前曾出现在 SERP 中，但在最近一次检查时未被发现
                  tasks.result.items.metrics.paid.clickstream_etv:
                    type: integer
                    description: >-
                      基于点击流数据估算的流量，即该域名获得排名的所有关键词的点击率与点击流搜索量乘积之和 要获取此字段的结果，必须将参数
                      include_clickstream_data 设置为 true
                      有关此指标计算方式的更多信息，请参阅此帮助中心文章
                  tasks.result.items.metrics.paid.clickstream_gender_distribution:
                    type: object
                    description: >-
                      按性别划分的基于估算点击流的指标分布；要检索此字段的结果，参数 include_clickstream_data
                      必须设置为 true；有关该指标计算方式的更多信息，请参阅此帮助中心文章
                  tasks.result.items.metrics.paid.female:
                    type: integer
                    description: 相关点击流数据集中的女性用户数量
                  tasks.result.items.metrics.paid.male:
                    type: integer
                    description: 相关点击流数据集中的男性用户数量
                  tasks.result.items.metrics.paid.clickstream_age_distribution:
                    type: object
                    description: >-
                      按年龄划分的基于点击流的指标分布。要检索此字段的结果，必须将参数 include_clickstream_data
                      设置为 true。有关该指标计算方式的更多信息，请参阅此帮助中心文章
                  tasks.result.items.metrics.paid.18-24:
                    type: integer
                    description: 相关点击流数据集中年龄在 18 至 24 岁范围内的用户数量
                  tasks.result.items.metrics.paid.25-34:
                    type: integer
                    description: 相关点击流数据集中年龄在 25-34 岁范围内的用户数量
                  tasks.result.items.metrics.paid.35-44:
                    type: integer
                    description: 相关点击流数据集中年龄在 35-44 岁范围内的用户数量
                  tasks.result.items.metrics.paid.45-54:
                    type: integer
                    description: 相关点击流数据集中年龄在 45-54 岁范围内的用户数量
                  tasks.result.items.metrics.paid.55-64:
                    type: integer
                    description: 相关点击流数据集中年龄在 55-64 岁范围内的用户数量
        '400':
          description: 错误请求
        '401':
          description: 未授权
        '429':
          description: 超出速率限制
        '500':
          description: 内部服务器错误
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````