跳转到主要内容
POST
https://api.aisa.one/apis/v1
/
dataforseo
/
dataforseo_labs
/
google
/
historical_rank_overview
/
live
历史排名概览
curl --request POST \
  --url https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/historical_rank_overview/live \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target": "<string>",
  "location_name": "<string>",
  "location_code": 123,
  "language_name": "<string>",
  "language_code": "<string>",
  "date_from": "<string>",
  "date_to": "<string>",
  "correlate": true,
  "ignore_synonyms": true,
  "include_clickstream_data": true,
  "tag": "<string>"
}
'
import requests

url = "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/historical_rank_overview/live"

payload = {
    "target": "<string>",
    "location_name": "<string>",
    "location_code": 123,
    "language_name": "<string>",
    "language_code": "<string>",
    "date_from": "<string>",
    "date_to": "<string>",
    "correlate": True,
    "ignore_synonyms": True,
    "include_clickstream_data": True,
    "tag": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    target: '<string>',
    location_name: '<string>',
    location_code: 123,
    language_name: '<string>',
    language_code: '<string>',
    date_from: '<string>',
    date_to: '<string>',
    correlate: true,
    ignore_synonyms: true,
    include_clickstream_data: true,
    tag: '<string>'
  })
};

fetch('https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/historical_rank_overview/live', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/historical_rank_overview/live",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'target' => '<string>',
    'location_name' => '<string>',
    'location_code' => 123,
    'language_name' => '<string>',
    'language_code' => '<string>',
    'date_from' => '<string>',
    'date_to' => '<string>',
    'correlate' => true,
    'ignore_synonyms' => true,
    'include_clickstream_data' => true,
    'tag' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/historical_rank_overview/live"

	payload := strings.NewReader("{\n  \"target\": \"<string>\",\n  \"location_name\": \"<string>\",\n  \"location_code\": 123,\n  \"language_name\": \"<string>\",\n  \"language_code\": \"<string>\",\n  \"date_from\": \"<string>\",\n  \"date_to\": \"<string>\",\n  \"correlate\": true,\n  \"ignore_synonyms\": true,\n  \"include_clickstream_data\": true,\n  \"tag\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/historical_rank_overview/live")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"target\": \"<string>\",\n  \"location_name\": \"<string>\",\n  \"location_code\": 123,\n  \"language_name\": \"<string>\",\n  \"language_code\": \"<string>\",\n  \"date_from\": \"<string>\",\n  \"date_to\": \"<string>\",\n  \"correlate\": true,\n  \"ignore_synonyms\": true,\n  \"include_clickstream_data\": true,\n  \"tag\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/dataforseo/dataforseo_labs/google/historical_rank_overview/live")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"target\": \"<string>\",\n  \"location_name\": \"<string>\",\n  \"location_code\": 123,\n  \"language_name\": \"<string>\",\n  \"language_code\": \"<string>\",\n  \"date_from\": \"<string>\",\n  \"date_to\": \"<string>\",\n  \"correlate\": true,\n  \"ignore_synonyms\": true,\n  \"include_clickstream_data\": true,\n  \"tag\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "version": "<string>",
  "status_code": 123,
  "status_message": "<string>",
  "time": "<string>",
  "cost": 123,
  "tasks_count": 123,
  "tasks_error": 123,
  "tasks": [
    "<string>"
  ],
  "tasks.id": "<string>",
  "tasks.status_code": 123,
  "tasks.status_message": "<string>",
  "tasks.time": "<string>",
  "tasks.cost": 123,
  "tasks.result_count": 123,
  "tasks.path": [
    "<string>"
  ],
  "tasks.data": {},
  "tasks.result": [
    "<string>"
  ],
  "tasks.result.se_type": "<string>",
  "tasks.result.target": "<string>",
  "tasks.result.location_code": 123,
  "tasks.result.language_code": "<string>",
  "tasks.result.total_count": 123,
  "tasks.result.items_count": 123,
  "tasks.result.items": [
    "<string>"
  ],
  "tasks.result.items.se_type": "<string>",
  "tasks.result.items.year": 123,
  "tasks.result.items.month": 123,
  "tasks.result.items.metrics": {},
  "tasks.result.items.metrics.organic": {},
  "tasks.result.items.metrics.organic.pos_1": 123,
  "tasks.result.items.metrics.organic.pos_2_3": 123,
  "tasks.result.items.metrics.organic.pos_4_10": 123,
  "tasks.result.items.metrics.organic.pos_11_20": 123,
  "tasks.result.items.metrics.organic.pos_21_30": 123,
  "tasks.result.items.metrics.organic.pos_31_40": 123,
  "tasks.result.items.metrics.organic.pos_41_50": 123,
  "tasks.result.items.metrics.organic.pos_51_60": 123,
  "tasks.result.items.metrics.organic.pos_61_70": 123,
  "tasks.result.items.metrics.organic.pos_71_80": 123,
  "tasks.result.items.metrics.organic.pos_81_90": 123,
  "tasks.result.items.metrics.organic.pos_91_100": 123,
  "tasks.result.items.metrics.organic.etv": 123,
  "tasks.result.items.metrics.organic.count": 123,
  "tasks.result.items.metrics.organic.estimated_paid_traffic_cost": 123,
  "tasks.result.items.metrics.organic.is_new": 123,
  "tasks.result.items.metrics.organic.is_up": 123,
  "tasks.result.items.metrics.organic.is_down": 123,
  "tasks.result.items.metrics.organic.is_lost": 123,
  "tasks.result.items.metrics.organic.clickstream_etv": 123,
  "tasks.result.items.metrics.organic.clickstream_gender_distribution": {},
  "tasks.result.items.metrics.organic.female": 123,
  "tasks.result.items.metrics.organic.male": 123,
  "tasks.result.items.metrics.organic.clickstream_age_distribution": {},
  "tasks.result.items.metrics.organic.18-24": 123,
  "tasks.result.items.metrics.organic.25-34": 123,
  "tasks.result.items.metrics.organic.35-44": 123,
  "tasks.result.items.metrics.organic.45-54": 123,
  "tasks.result.items.metrics.organic.55-64": 123,
  "tasks.result.items.metrics.paid": {},
  "tasks.result.items.metrics.paid.pos_1": 123,
  "tasks.result.items.metrics.paid.pos_2_3": 123,
  "tasks.result.items.metrics.paid.pos_4_10": 123,
  "tasks.result.items.metrics.paid.pos_11_20": 123,
  "tasks.result.items.metrics.paid.pos_21_30": 123,
  "tasks.result.items.metrics.paid.pos_31_40": 123,
  "tasks.result.items.metrics.paid.pos_41_50": 123,
  "tasks.result.items.metrics.paid.pos_51_60": 123,
  "tasks.result.items.metrics.paid.pos_61_70": 123,
  "tasks.result.items.metrics.paid.pos_71_80": 123,
  "tasks.result.items.metrics.paid.pos_81_90": 123,
  "tasks.result.items.metrics.paid.pos_91_100": 123,
  "tasks.result.items.metrics.paid.etv": 123,
  "tasks.result.items.metrics.paid.count": 123,
  "tasks.result.items.metrics.paid.estimated_paid_traffic_cost": 123,
  "tasks.result.items.metrics.paid.is_new": 123,
  "tasks.result.items.metrics.paid.is_up": 123,
  "tasks.result.items.metrics.paid.is_down": 123,
  "tasks.result.items.metrics.paid.is_lost": 123,
  "tasks.result.items.metrics.paid.clickstream_etv": 123,
  "tasks.result.items.metrics.paid.clickstream_gender_distribution": {},
  "tasks.result.items.metrics.paid.female": 123,
  "tasks.result.items.metrics.paid.male": 123,
  "tasks.result.items.metrics.paid.clickstream_age_distribution": {},
  "tasks.result.items.metrics.paid.18-24": 123,
  "tasks.result.items.metrics.paid.25-34": 123,
  "tasks.result.items.metrics.paid.35-44": 123,
  "tasks.result.items.metrics.paid.45-54": 123,
  "tasks.result.items.metrics.paid.55-64": 123
}

授权

​
Authorization
string
header
必填

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

请求体

application/json
​
target
string
必填

domain 必填字段，目标网站的域名；指定域名时不应包含 https:// 和 www.

​
location_name
string
必填

位置的完整名称；未指定 location_code 时为必填字段。注意：必须指定 location_name 或 location_code 之一。您可以通过向 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages 单独发送请求，获取包含 location_name 的可用位置列表；示例：United Kingdom

​
location_code
integer
必填

位置代码；如果未指定 location_name，则为必填字段。注意：必须指定 location_name 或 location_code 其中之一；可通过向 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages 单独发起请求，获取可用位置及其 location_code 的列表；示例：2840

​
language_name
string
必填

语言的完整名称 如果未指定 language_code，则为必填字段 注意：必须指定 language_name 或 language_code 之一 可以通过向 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages 单独发送请求，获取包含 language_name 的可用位置列表 示例：English

​
language_code
string
必填

语言代码；如果未指定 language_name，则此字段为必填字段。注意：必须指定 language_name 或 language_code 之一。您可以通过向 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages 单独发送请求，获取可用位置及其 language_code 的列表。示例：en

​
date_from
string

时间范围的起始日期。可选字段；如果未指定此字段，将提供前 6 个月的数据。最小可用值：2020-10-01。日期格式："yyyy-mm-dd"

​
date_to
string

时间范围的结束日期，可选字段。如果未指定此字段，则默认使用今天的日期。日期格式："yyyy-mm-dd"，示例："2021-04-01"

​
correlate
boolean

将数据与之前获取的数据集关联；可选字段；默认值：true；如果使用此参数，系统会将当前获取的数据与之前获取的数据集关联；此参数旨在减少数据库变更可能导致的任何不一致；建议始终将 correlate 设置为 true

​
ignore_synonyms
boolean

忽略高度相似的关键词，可选字段；如果设置为 true，则仅返回基于核心关键词的数据，并排除所有高度相似关键词的数据；默认值：false

​
include_clickstream_data
boolean

在结果中包含或排除基于点击流的指标数据，可选字段。如果将该参数设置为 true，响应中将包含带有点击流数据的 clickstream_etv、clickstream_gender_distribution 和 clickstream_age_distribution 字段；默认值：false。注意：历史点击流数据从 2024/05（2024 年 5 月）起可用；启用此参数后，该请求将按双倍价格收费；有关基于点击流的指标如何计算的更多信息，请参阅此帮助中心文章

​
tag
string

用户定义的任务标识符。可选字段。字符数限制为 255。您可以使用此参数标识任务并将其与结果匹配；您将在响应的 data 对象中找到指定的 tag 值

响应

成功响应

​
version
string

API 的当前版本

​
status_code
integer

通用状态码；您可以在此处查看完整的响应码列表。注意：我们强烈建议设计必要的系统来处理相关异常或错误情况

​
status_message
string

常规信息消息；可在此处查看常规信息消息的完整列表

​
time
string

执行时间（秒）

​
cost
number

任务总成本（美元）

​
tasks_count
integer

tasks 数组中的任务数量

​
tasks_error
integer

返回错误的 tasks 数组中的任务数量

​
tasks
string[]

任务数组

​
tasks.id
string

任务标识符，系统中采用 UUID 格式的唯一任务标识符

​
tasks.status_code
integer

DataForSEO 生成的任务状态码；范围为：10000-60000；完整响应代码列表可在此处查看

​
tasks.status_message
string

任务的信息性消息，你可以在此处查看通用信息性消息的完整列表

​
tasks.time
string

执行时间（秒）

​
tasks.cost
number

任务成本（美元）

​
tasks.result_count
integer

结果数组中的元素数量

​
tasks.path
string[]

URL 路径

​
tasks.data
object

包含您在 POST 请求中指定的相同参数

​
tasks.result
string[]

结果数组

​
tasks.result.se_type
string

搜索引擎类型

​
tasks.result.target
string

POST 数组中的目标域名

​
tasks.result.location_code
integer

POST 数组中的位置代码

​
tasks.result.language_code
string

POST 数组中的语言代码

​
tasks.result.total_count
integer

数据库中与您的请求相关的结果总量

​
tasks.result.items_count
integer

items 数组中返回的结果数量

​
tasks.result.items
string[]

包含历史排名和流量数据

​
tasks.result.items.se_type
string

搜索引擎类型

​
tasks.result.items.year
integer

所提供数据对应的年份

​
tasks.result.items.month
integer

数据对应的月份

​
tasks.result.items.metrics
object

与指定域名相关的排名数据

​
tasks.result.items.metrics.organic
object

自然搜索的排名和流量数据

​
tasks.result.items.metrics.organic.pos_1
integer

域名排名第 #1 的自然搜索 SERP 数量

​
tasks.result.items.metrics.organic.pos_2_3
integer

域名自然搜索结果排名第 2–3 位的数量

​
tasks.result.items.metrics.organic.pos_4_10
integer

域名排名第 4-10 位的自然搜索结果页数量

​
tasks.result.items.metrics.organic.pos_11_20
integer

域名排名第 11-20 位的自然搜索结果页数量

​
tasks.result.items.metrics.organic.pos_21_30
integer

域名排名第 21-30 位的自然搜索结果页数量

​
tasks.result.items.metrics.organic.pos_31_40
integer

域名排名第 31-40 位的自然搜索结果页数量

​
tasks.result.items.metrics.organic.pos_41_50
integer

域名排名第 41–50 位的自然搜索结果页数量

​
tasks.result.items.metrics.organic.pos_51_60
integer

域名排名第 51–60 位的自然搜索结果页数量

​
tasks.result.items.metrics.organic.pos_61_70
integer

域名排名第 #61-70 位的自然搜索结果数量

​
tasks.result.items.metrics.organic.pos_71_80
integer

域名排名第 71-80 位的自然搜索结果页数量

​
tasks.result.items.metrics.organic.pos_81_90
integer

该域名排名第 81-90 位的自然搜索 SERP 数量

​
tasks.result.items.metrics.organic.pos_91_100
integer

该域名排名第 91-100 位的自然搜索 SERP 数量

​
tasks.result.items.metrics.organic.etv
number

预估流量 域名的预估自然搜索月流量，计算方式为该域名参与排名的所有关键词的 CTR（点击率）与搜索量之乘积的总和；有关此指标计算方式的更多信息，请参阅此帮助中心文章

​
tasks.result.items.metrics.organic.count
integer

包含该域名的自然搜索 SERP 总数

​
tasks.result.items.metrics.organic.estimated_paid_traffic_cost
number

将自然搜索流量转化为付费流量的估算成本，表示为某个域名有排名的所有关键词投放广告的估算每月成本（USD）；该指标通过 organic etv 与 paid cpc 值的乘积计算，表示通过 Google Search 中的 PPC 广告获得估算每月自然流量所需的成本。有关该指标如何计算的更多信息，请参阅此帮助中心文章

​
tasks.result.items.metrics.organic.is_new
integer

新排名元素的数量，表示为指定目标发现了多少个新排名元素

​
tasks.result.items.metrics.organic.is_up
integer

排名上升，表示指定目标中排名上升的元素数量

​
tasks.result.items.metrics.organic.is_down
integer

排名下降 表示指定目标中排名下降的元素数量

​
tasks.result.items.metrics.organic.is_lost
integer

丢失的排名元素；表示所指目标中有多少排名元素此前曾出现在 SERP 中，但在最近一次检查时未被发现

​
tasks.result.items.metrics.organic.clickstream_etv
integer

基于点击流数据估算的流量，即该域名获得排名的所有关键词的点击率与点击流搜索量乘积之和 要获取此字段的结果，必须将参数 include_clickstream_data 设置为 true 有关此指标计算方式的更多信息，请参阅此帮助中心文章

​
tasks.result.items.metrics.organic.clickstream_gender_distribution
object

按性别划分的基于估算点击流的指标分布；要检索此字段的结果，参数 include_clickstream_data 必须设置为 true；有关该指标计算方式的更多信息，请参阅此帮助中心文章

​
tasks.result.items.metrics.organic.female
integer

相关点击流数据集中的女性用户数量

​
tasks.result.items.metrics.organic.male
integer

相关点击流数据集中的男性用户数量

​
tasks.result.items.metrics.organic.clickstream_age_distribution
object

按年龄划分的基于点击流的指标分布。要检索此字段的结果，必须将参数 include_clickstream_data 设置为 true。有关该指标计算方式的更多信息，请参阅此帮助中心文章

​
tasks.result.items.metrics.organic.18-24
integer

相关点击流数据集中年龄在 18 至 24 岁范围内的用户数量

​
tasks.result.items.metrics.organic.25-34
integer

相关点击流数据集中年龄在 25-34 岁范围内的用户数量

​
tasks.result.items.metrics.organic.35-44
integer

相关点击流数据集中年龄在 35-44 岁范围内的用户数量

​
tasks.result.items.metrics.organic.45-54
integer

相关点击流数据集中年龄在 45-54 岁范围内的用户数量

​
tasks.result.items.metrics.organic.55-64
integer

相关点击流数据集中年龄在 55-64 岁范围内的用户数量

​
tasks.result.items.metrics.paid
object

付费搜索的排名和流量数据

​
tasks.result.items.metrics.paid.pos_1
integer

该域名排名第 1 的付费 SERP 数量

​
tasks.result.items.metrics.paid.pos_2_3
integer

域名排名第 #2-3 位的付费 SERP 数量

​
tasks.result.items.metrics.paid.pos_4_10
integer

域名排名第 #4-10 位的付费 SERP 数量

​
tasks.result.items.metrics.paid.pos_11_20
integer

域名排名第 #11-20 位的付费 SERP 数量

​
tasks.result.items.metrics.paid.pos_21_30
integer

该域名在付费 SERP 中排名第 21-30 位的数量

​
tasks.result.items.metrics.paid.pos_31_40
integer

域名排名第 #31-40 位的付费 SERP 数量

​
tasks.result.items.metrics.paid.pos_41_50
integer

域名排名第 #41-50 位的付费 SERP 数量

​
tasks.result.items.metrics.paid.pos_51_60
integer

域名在付费搜索结果页中排名第 51-60 位的数量

​
tasks.result.items.metrics.paid.pos_61_70
integer

域名排名第 #61-70 位的付费 SERP 数量

​
tasks.result.items.metrics.paid.pos_71_80
integer

域名排名第 #71-80 位的付费 SERP 数量

​
tasks.result.items.metrics.paid.pos_81_90
integer

域名排名第 81-90 位的付费搜索结果页数量

​
tasks.result.items.metrics.paid.pos_91_100
integer

域名在付费搜索结果中排名第 91-100 位的 SERP 数量

​
tasks.result.items.metrics.paid.etv
number

预估流量：域名的预估每月付费流量，计算方式为该域名排名涉及的所有关键词的 CTR（点击率）与搜索量之积；有关此指标计算方式的更多信息，请参阅此帮助中心文章

​
tasks.result.items.metrics.paid.count
integer

包含该域名的付费 SERP 总数

​
tasks.result.items.metrics.paid.estimated_paid_traffic_cost
number

每月搜索流量的预估成本。表示根据 etv 和 cpc 值估算的每月付费流量成本（USD）。有关该指标计算方式的更多信息，请参阅此帮助中心文章

​
tasks.result.items.metrics.paid.is_new
integer

新排名元素的数量，表示为指定目标发现了多少个新排名元素

​
tasks.result.items.metrics.paid.is_up
integer

排名上升，表示指定目标中排名上升的元素数量

​
tasks.result.items.metrics.paid.is_down
integer

排名下降 表示指定目标中排名下降的元素数量

​
tasks.result.items.metrics.paid.is_lost
integer

丢失的排名元素；表示所指目标中有多少排名元素此前曾出现在 SERP 中，但在最近一次检查时未被发现

​
tasks.result.items.metrics.paid.clickstream_etv
integer

基于点击流数据估算的流量，即该域名获得排名的所有关键词的点击率与点击流搜索量乘积之和 要获取此字段的结果，必须将参数 include_clickstream_data 设置为 true 有关此指标计算方式的更多信息，请参阅此帮助中心文章

​
tasks.result.items.metrics.paid.clickstream_gender_distribution
object

按性别划分的基于估算点击流的指标分布；要检索此字段的结果，参数 include_clickstream_data 必须设置为 true；有关该指标计算方式的更多信息，请参阅此帮助中心文章

​
tasks.result.items.metrics.paid.female
integer

相关点击流数据集中的女性用户数量

​
tasks.result.items.metrics.paid.male
integer

相关点击流数据集中的男性用户数量

​
tasks.result.items.metrics.paid.clickstream_age_distribution
object

按年龄划分的基于点击流的指标分布。要检索此字段的结果，必须将参数 include_clickstream_data 设置为 true。有关该指标计算方式的更多信息，请参阅此帮助中心文章

​
tasks.result.items.metrics.paid.18-24
integer

相关点击流数据集中年龄在 18 至 24 岁范围内的用户数量

​
tasks.result.items.metrics.paid.25-34
integer

相关点击流数据集中年龄在 25-34 岁范围内的用户数量

​
tasks.result.items.metrics.paid.35-44
integer

相关点击流数据集中年龄在 35-44 岁范围内的用户数量

​
tasks.result.items.metrics.paid.45-54
integer

相关点击流数据集中年龄在 45-54 岁范围内的用户数量

​
tasks.result.items.metrics.paid.55-64
integer

相关点击流数据集中年龄在 55-64 岁范围内的用户数量