# 历史排名概览

**API:** Data API

**Endpoint:** `POST /v1/beta/dataforseo/dataforseo_labs/google/historical_rank_overview/live`

**Tags:** DataForSEO

某个域名在可用历史中每个时间点的排名概览。该端点不接受 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 计费记录为准。

## Base URL

- `https://openapi.felo.ai`

## Authentication

- `FeloBearerAuth` (http bearer, bearer format Felo API Key)
- `FeloApiKey` (apiKey in header `X-API-Key`)

## Request body

Required: **no**

### application/json

Schema:

```json
{
  "type": "array",
  "items": {
    "type": [
      "object",
      "null"
    ],
    "oneOf": [
      {
        "type": "object",
        "properties": {
          "target": {
            "type": "string",
            "description": "<em>域名</em><br><strong>必填字段</strong><br>目标网站的域名<br>域名不应包含 <code>https://</code> 和 <code>www.</code>"
          },
          "location_name": {
            "type": "string",
            "description": "<em>地点全名</em><br><strong>未指定 <code>location_code</code> 时为必填字段</strong><br><strong>注意：</strong>必须指定 <code>location_name</code> 或 <code>location_code</code><br>可单独向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 发起请求，获取可用地点及其 <code>location_name</code> 的列表<br>示例：<br><code class=\"long-string\">United Kingdom</code>"
          },
          "location_code": {
            "type": "integer",
            "description": "<em>地点代码</em><br><strong>未指定 <code>location_name</code> 时为必填字段</strong><br><strong>注意：</strong>必须指定 <code>location_name</code> 或 <code>location_code</code><br>可单独向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 发起请求，获取可用地点及其 <code>location_code</code> 的列表<br>示例：<br><code class=\"long-string\">2840</code>"
          },
          "language_name": {
            "type": "string",
            "description": "<em>语言全名</em><br><strong>未指定 <code>language_code</code> 时为必填字段</strong><br><strong>注意：</strong>必须指定 <code>language_name</code> 或 <code>language_code</code><br>可单独向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 发起请求，获取可用地点及其 <code>language_name</code> 的列表<br>示例：<br><code class=\"long-string\">English</code>"
          },
          "language_code": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>语言代码</em><br><strong>未指定 <code>language_name</code> 时为必填字段</strong><br><strong>注意：</strong>必须指定 <code>language_name</code> 或 <code>language_code</code><br>可单独向 <br><code>https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages</code> 发起请求，获取可用地点及其 <code>language_code</code> 的列表<br>示例：<br><code class=\"long-string\">en</code>"
          },
          "date_from": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>时间范围的开始日期</em><br>可选字段<br>如果未指定此字段，将提供过去 6 个月的数据<br>最小可能值：<code>2020-10-01</code><br>日期格式：<code>\"yyyy-mm-dd\"</code>"
          },
          "date_to": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>时间范围的结束日期</em><br>可选字段<br>如果未指定此字段，默认使用今天的日期<br>日期格式：<code>\"yyyy-mm-dd\"</code><br>示例：<br><code>\"2021-04-01\"</code>"
          },
          "correlate": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>将数据与先前获取的数据集关联</em><br>可选字段<br>默认值：<code>true</code><br>如果使用此参数，我们的系统会将你现在获取的数据与先前获取的数据集关联<br>此参数旨在减少因数据库变更而可能产生的不一致<br>建议始终将 <code>correlate</code> 设为 <code>true</code>"
          },
          "ignore_synonyms": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>忽略高度相似的关键词</em><br>可选字段<br>如果设为 <code class=\"prettyprint\">true</code>，则只返回基于核心关键词的数据，所有高度相似的关键词的数据都将被排除；  <br>默认值：<code>false</code>"
          },
          "include_clickstream_data": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "<em>在结果中包含或排除基于点击流的指标数据</em><br>可选字段<br>如果参数设为 <code>true</code>，响应中将包含带有点击流数据的 <code>clickstream_etv</code>、<code>clickstream_gender_distribution</code> 和 <code>clickstream_age_distribution</code> 字段；<br>默认值：<code>false</code>；<p><strong>注意：</strong>历史点击流数据自 2024/05（2024 年 5 月）起可用；<br><strong>启用此参数后，该请求将按双倍价格计费；</strong><br>有关基于点击流的指标如何计算的更多信息，请参阅这篇 <a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">帮助中心文章</a>"
          },
          "tag": {
            "type": [
              "string",
              "null"
            ],
            "description": "<em>用户自定义任务标识符</em><br>可选字段<br><em>字符数上限为 255</em><br>可使用此参数标识任务，并将其与结果对应<br>可在响应的 <code>data</code> 对象中找到指定的 <code>tag</code> 值"
          }
        },
        "example": [
          {
            "target": "dataforseo.com",
            "location_code": 2840,
            "language_code": "en",
            "date_from": "2021-01-01",
            "date_to": "2021-03-29"
          }
        ]
      }
    ]
  },
  "example": [
    {
      "target": "dataforseo.com",
      "location_code": 2840,
      "language_code": "en",
      "date_from": "2021-01-01",
      "date_to": "2021-03-29"
    }
  ]
}
```

## Responses

### 200 — 操作成功

Headers:
- `X-Request-Id` (string) — 联系 Felo 支持时需提供的请求标识符。

**application/json**

Schema: object | null

```json
{
  "type": [
    "object",
    "null"
  ],
  "oneOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResponseInfo"
    }
  ]
}
```

### 400 — 无法处理该请求。请检查请求参数。

### 401 — 需要有效的 Felo API 密钥。

### 402 — 由于未满足计费要求，请求无法继续。

### 403 — 该账户无权执行此操作。

### 429 — 已达到请求或支出限额。

### 502 — 服务无法完成该请求。

### 503 — API 或计费服务暂时不可用。

### 504 — 服务在处理请求时超时。

### default — 错误响应；上游透传响应可能采用提供方格式

**application/json**

Schema:

```json
{}
```

## Schema definitions

### Response36Afe1097B20_BaseResponseInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`

```json
{
  "properties": {
    "version": {
      "type": [
        "string",
        "null"
      ],
      "description": "API 的当前版本"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "通用状态码\n完整响应码列表见此处"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "通用信息性消息\n完整的一般信息性消息列表见此处"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "总执行时间，秒"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "任务总费用，美元",
      "format": "double"
    },
    "tasks_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "tasks 数组中的任务数",
      "format": "int64"
    },
    "tasks_error": {
      "type": [
        "integer",
        "null"
      ],
      "description": "tasks 数组中返回错误的任务数",
      "format": "int64"
    }
  }
}
```

### Response36Afe1097B20_BaseResponseTaskInfo

`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`

```json
{
  "properties": {
    "id": {
      "type": [
        "string",
        "null"
      ],
      "description": "任务标识符\n我们系统中 UUID 格式的唯一任务标识符"
    },
    "status_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "任务的状态码\n由 DataForSEO 生成，范围如下：10000-60000\n完整响应码列表见此处"
    },
    "status_message": {
      "type": [
        "string",
        "null"
      ],
      "description": "任务的信息性消息\n完整的一般信息性消息列表见此处"
    },
    "time": {
      "type": [
        "string",
        "null"
      ],
      "description": "执行时间，秒"
    },
    "cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "任务总费用，美元",
      "format": "double"
    },
    "result_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "result 数组中的元素数",
      "format": "int64"
    },
    "path": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "string",
          "null"
        ]
      },
      "description": "URL 路径"
    },
    "data": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "object",
          "null"
        ]
      },
      "description": "包含你在 POST 请求中指定的相同参数"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveItem

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveItem`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>搜索引擎类型</em>"
    },
    "year": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>数据所属的年份</em>"
    },
    "month": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>数据所属的月份</em>"
    },
    "metrics": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsMetricsInfo"
      },
      "description": "<em>与指定域名相关的排名数据</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResponseInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResponseInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
    },
    {
      "type": "object",
      "properties": {
        "tasks": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveTaskInfo"
              }
            ]
          },
          "description": "<em>任务数组</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo`

```json
{
  "type": "object",
  "properties": {
    "se_type": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>搜索引擎类型</em>"
    },
    "target": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 数组中的目标域名</em>"
    },
    "location_code": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>POST 数组中的位置代码</em>"
    },
    "language_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "<em>POST 数组中的语言代码</em>"
    },
    "total_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>我们数据库中与你的请求相关的结果总数</em>",
      "format": "int64"
    },
    "items_count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em><code>items</code> 数组中返回的结果数</em>",
      "format": "int64"
    },
    "items": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": [
          "object",
          "null"
        ],
        "oneOf": [
          {
            "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveItem"
          }
        ]
      },
      "description": "<em>包含历史排名和流量数据</em>"
    }
  }
}
```

### Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveTaskInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveTaskInfo`

```json
{
  "type": "object",
  "allOf": [
    {
      "$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
    },
    {
      "type": "object",
      "properties": {
        "result": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": [
              "object",
              "null"
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo"
              }
            ]
          },
          "description": "<em>结果数组</em>"
        }
      }
    }
  ]
}
```

### Response36Afe1097B20_DataforseoLabsMetricsInfo

`#/components/schemas/Response36Afe1097B20_DataforseoLabsMetricsInfo`

```json
{
  "type": "object",
  "properties": {
    "pos_1": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>域名或子域排名第 1 位的自然 SERP 数量</em>"
    },
    "pos_2_3": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>域名或子域排名第 2-3 位的自然 SERP 数量</em>"
    },
    "pos_4_10": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>域名或子域排名第 4-10 位的自然 SERP 数量</em>"
    },
    "pos_11_20": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>域名或子域排名第 11-20 位的自然 SERP 数量</em>"
    },
    "pos_21_30": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>域名或子域排名第 21-30 位的自然 SERP 数量</em>"
    },
    "pos_31_40": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>域名或子域排名第 31-40 位的自然 SERP 数量</em>"
    },
    "pos_41_50": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>域名或子域排名第 41-50 位的自然 SERP 数量</em>"
    },
    "pos_51_60": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>域名或子域排名第 51-60 位的自然 SERP 数量</em>"
    },
    "pos_61_70": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>域名或子域排名第 61-70 位的自然 SERP 数量</em>"
    },
    "pos_71_80": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>域名或子域排名第 71-80 位的自然 SERP 数量</em>"
    },
    "pos_81_90": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>域名或子域排名第 81-90 位的自然 SERP 数量</em>"
    },
    "pos_91_100": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>域名或子域排名第 91-100 位的自然 SERP 数量</em>"
    },
    "etv": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>估算流量</em><br>该域名或子域的估算自然搜索月流量<br>由该域名或子域在类别中排名的所有关键词的 CTR（点击率）与搜索量的乘积计算得出<br>如需了解该指标的计算方式，请参阅<a href=\"https://dataforseo.com/help-center/how-is-etv-calculated\" rel=\"noopener noreferrer\" target=\"_blank\">此帮助中心文章</a>"
    },
    "count": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>包含该域名或子域的自然 SERP 总数</em>",
      "format": "int64"
    },
    "estimated_paid_traffic_cost": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>将自然搜索流量转化为付费流量的估算成本</em><br>表示域名或子域在类别中排名的所有关键词的估算每月广告成本（美元）<br>该指标按自然 <code>etv</code> 与付费 <code>cpc</code> 值的乘积计算，表示通过 Google 搜索中的 PPC 广告带来估算每月自然流量所需的成本<br>如需了解该指标的计算方式，请参阅<a href=\"https://dataforseo.com/help-center/how-is-traffic-cost-calculated\" rel=\"noopener noreferrer\" target=\"_blank\">此帮助中心文章</a>"
    },
    "is_new": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>新增排名元素数量</em><br>表示指定目标发现了多少新的排名元素"
    },
    "is_up": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>排名上升</em><br>表示指定目标有多少排名元素上升"
    },
    "is_down": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>排名下降</em><br>表示指定目标有多少排名元素下降"
    },
    "is_lost": {
      "type": [
        "integer",
        "null"
      ],
      "description": "<em>丢失的排名元素</em><br>表示指定目标有多少排名元素此前出现在 SERP 中，但在上次检查时未找到"
    },
    "clickstream_etv": {
      "type": [
        "number",
        "null"
      ],
      "description": "<em>基于点击流数据的估算流量</em><br>按域名所排名所有关键词的点击率（CTR）与点击流搜索量值的乘积计算<br>要获取此字段的结果，参数 <code>include_clickstream_data</code> 必须设为 <code>true</code><br>如需了解该指标的计算方式，请参阅<a href=\"https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated\" rel=\"noopener noreferrer\" target=\"_blank\">此帮助中心文章</a>",
      "format": "double"
    },
    "clickstream_gender_distribution": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>按性别划分的估算点击流指标分布</em><br>要获取此字段的结果，参数 <code>include_clickstream_data</code> 必须设为 <code>true</code><br>如需了解该指标的计算方式，请参阅<a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">此帮助中心文章</a>"
    },
    "clickstream_age_distribution": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "type": [
          "integer",
          "null"
        ],
        "format": "int64"
      },
      "description": "<em>按年龄划分的基于点击流的指标分布</em><br>要获取此字段的结果，参数 <code>include_clickstream_data</code> 必须设为 <code>true</code><br>如需了解该指标的计算方式，请参阅<a href=\"https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them\" rel=\"noopener noreferrer\" target=\"_blank\">此帮助中心文章</a>"
    }
  }
}
```