主题
域名排名概览(旧版)
GET /v3/dataforseo_labs/locations_and_languages
本接口使用 POST 方法,请求路径为:
/v3/dataforseo_labs/domain_rank_overview/live
> 旧版接口说明:本接口沿用旧版请求与响应结构。接口可返回指定域名在自然搜索和付费搜索中的排名分布、预估月流量及流量价值等数据。新项目建议优使用新版域名排名概览接口。
接口说明
本接口用于查询指定域名的搜索表现:
- 域名在自然搜索结果中的排名分布;
- 域名在付费搜索结果中的排名分布;
- 自然搜索和付费搜索的预估月流量;
- 基于点击率、搜索量、展示次数和每次点击费用计算的流量价值;
- 新增、上升、下降和丢失的排名数量。
所有 POST 请求体使用 UTF-8 编码的 JSON 格式,并将任务参数放 JSON 数组中。每个请求最多提交 1 个任务;平台限流以认证说明中的 30/60/120 次/分钟规则为准。
扣费以响应头 X-SeerMarTech-Charge-CNY 为准。
请求参数
请求体格式为 JSON 数组:
json
[
{
"target": "example.com",
"location_name": "United States",
"language_name": "English"
}
]| 参数 | 类型 | 填 | 说明 |
|---|---|---|---|
target | string | 是 | 目标域名。请勿 https:// 或 www.。例如:example.com |
location_name | string | 否 | 地区名。使用此参数时无需传 location_code。可通过 /v3/dataforseo_labs/locations_and_languages 获取可用地区。忽略此参数时,返回所有可用地区的数据。示例:United States |
location_code | integer | 否 | 地区代码。使用此参数时无需传 location_name。可通过 /v3/dataforseo_labs/locations_and_languages 获取可用地区代码。忽略此参数时,返回所有可用地区的数据。示例:2840 |
language_name | string | 否 | 语言名。使用此参数时无需传 language_code。可通过 /v3/dataforseo_labs/locations_and_languages 获取可用语言。忽略此参数时,返回所有可用语言的数据。示例:English |
language_code | string | 否 | 语言代码。使用此参数时无需传 language_name。可通过 /v3/dataforseo_labs/locations_and_languages 获取可用语言代码。示例:en |
limit | integer | 否 | 返回结果的最大数量。默认值为 100,最大值为 1000。 |
offset | integer | 否 | 结果偏移量,默认值为 0。例如设置为 10 时,将跳过结果数组中的前 10 条数据。 |
tag | string | 否 | 用户自定义任务标识,最长 255 个字符。该值会原样返回在响应的 data 对象中,可用于请求与结果。 |
location_name 与 location_code 二选一;language_name 与 language_code 二选一。
响应结构
接口返回 JSON 数据 tasks 数组。
顶层响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
version | string | 当前 API 版本。 |
status_code | integer | 通用响应状态码。 |
status_message | string | 通用状态说明。 |
time | string | 接口执行耗时,单位为秒。 |
cost | float | 平台原始 USD 成本兼容字段;人民币实扣以 X-SeerMarTech-Charge-CNY 为准。 |
tasks_count | integer | tasks 数组中的任务总数。 |
tasks_error | integer | tasks 数组中返回错误的任务数量。 |
tasks | array | 任务结果数组。 |
任务字段
| 字段 | 类型 | 说明 |
|---|---|---|
id | string | 任务唯一标识,UUID 格式。 |
status_code | integer | 任务状态码,通常在 10000 至 60000 范围。 |
status_message | string | 任务状态说明。 |
time | string | 任务执行耗时,单位为秒。 |
cost | float | 平台原始 USD 成本兼容字段;人民币实扣以 X-SeerMarTech-Charge-CNY 为准。 |
result_count | integer | result 数组中的数量。 |
path | array | 请求 URL 路径。 |
data | object | 请求中提交的任务参数。 |
result | array | 任务结果数组。 |
result 字段
| 字段 | 类型 | 说明 |
|---|---|---|
target | string | 请求中的目标域名。 |
location_code | integer | 请求中的地区代码。 |
language_code | string | 请求中的语言代码。 |
total_count | integer | 数据库中与请求条件匹的结果总数。 |
items_count | integer | items 数组中返回的结果数量。 |
items | array | 含域名排名和流量数据的结果项。 |
metrics 指标
items 中的 metrics 对象指定域名的排名数据,分为 organic 和 paid 两部分。
自然搜索指标:organic
| 字段 | 类型 | 说明 |
|---|---|---|
pos_1 | integer | 域名排名第 1 的自然搜索结果数量。 |
pos_2_3 | integer | 域名排名第 2 至第 3 的自然搜索结果数量。 |
pos_4_10 | integer | 域名排名第 4 至第 10 的自然搜索结果数量。 |
pos_11_20 | integer | 域名排名第 11 至第 20 的自然搜索结果数量。 |
pos_21_30 | integer | 域名排名第 21 至第 30 的自然搜索结果数量。 |
pos_31_40 | integer | 域名排名第 31 至第 40 的自然搜索结果数量。 |
pos_41_50 | integer | 域名排名第 41 至第 50 的自然搜索结果数量。 |
pos_51_60 | integer | 域名排名第 51 至第 60 的自然搜索结果数量。 |
pos_61_70 | integer | 域名排名第 61 至第 70 的自然搜索结果数量。 |
pos_71_80 | integer | 域名排名第 71 至第 80 的自然搜索结果数量。 |
pos_81_90 | integer | 域名排名第 81 至第 90 的自然搜索结果数量。 |
pos_91_100 | integer | 域名排名第 91 至第 100 的自然搜索结果数量。 |
etv | float | 预估自然搜索月流量。通常按域名排名的点击率(CTR)与搜索量乘积汇总计算。 |
impressions_etv | float | 基于展示次数计算的预估自然搜索月流量,通常按点击率(CTR)与展示次数乘积汇总计算。 |
count | integer | 含该域名的自然搜索结果总数。 |
estimated_paid_traffic_cost | float | 将预估自然搜索流量通过付费搜索获取时的预估月成本。通常按自然搜索 etv 与付费搜索 cpc 计算。 |
is_new | integer | 新发现的排名数量。 |
is_up | integer | 排名上升的数量。 |
is_down | integer | 排名下降的数量。 |
is_lost | integer | 上一次检查中存在、但本次检查未发现的排名数量。 |
付费搜索指标:paid
| 字段 | 类型 | 说明 |
|---|---|---|
pos_1 | integer | 域名排名第 1 的付费搜索结果数量。 |
pos_2_3 | integer | 域名排名第 2 至第 3 的付费搜索结果数量。 |
pos_4_10 | integer | 域名排名第 4 至第 10 的付费搜索结果数量。 |
pos_11_20 | integer | 域名排名第 11 至第 20 的付费搜索结果数量。 |
pos_21_30 | integer | 域名排名第 21 至第 30 的付费搜索结果数量。 |
pos_31_40 | integer | 域名排名第 31 至第 40 的付费搜索结果数量。 |
pos_41_50 | integer | 域名排名第 41 至第 50 的付费搜索结果数量。 |
pos_51_60 | integer | 域名排名第 51 至第 60 的付费搜索结果数量。 |
pos_61_70 | integer | 域名排名第 61 至第 70 的付费搜索结果数量。 |
pos_71_80 | integer | 域名排名第 71 至第 80 的付费搜索结果数量。 |
pos_81_90 | integer | 域名排名第 81 至第 90 的付费搜索结果数量。 |
pos_91_100 | integer | 域名排名第 91 至第 100 的付费搜索结果数量。 |
etv | float | 预估付费搜索月流量,通常按点击率(CTR)与搜索量乘积汇总计算。 |
impressions_etv | float | 基于展示次数计算的预估付费搜索月流量,通常按点击率(CTR)与展示次数乘积汇总计算。 |
count | integer | 含该域名的付费搜索结果总数。 |
estimated_paid_traffic_cost | float | 基于 etv 和 cpc 计算的预估付费搜索月流量成本。 |
is_new | integer | 新发现的排名数量。 |
is_up | integer | 排名上升的数量。 |
is_down | integer | 排名下降的数量。 |
is_lost | integer | 上一次检查中存在、但本次检查未发现的排名数量。 |
认证方式
请求在 HTTP Header 中传:
http
Authorization: Bearer smt_live_YOUR_KEY
Content-Type: application/json请求示例
curl
bash
curl --location --request POST \
"https://api.seermartech.cn/v3/dataforseo_labs/domain_rank_overview/live" \
--header "Authorization: Bearer smt_live_YOUR_KEY" \
--header "Content-Type: application/json" \
--data-raw '[
{
"target": "example.com",
"location_name": "United States",
"language_name": "English"
}
]'Python
python
import requests
url = "https://api.seermartech.cn/v3/dataforseo_labs/domain_rank_overview/live"
headers = {
"Authorization": "Bearer smt_live_YOUR_KEY",
"Content-Type": "application/json",
}
post_data = [
{
"target": "example.com",
"location_name": "United States",
"language_name": "English",
}
]
response = requests.post(url, headers=headers, json=post_data)
result = response.json()
if result.get("status_code") == 20000:
print(result)
else:
print(
"请求失败。状态码:%s,说明:%s"
% (result.get("status_code"), result.get("status_message"))
)TypeScript
typescript
import axios from "axios";
const postData = [
{
target: "example.com",
location_name: "United States",
language_name: "English",
},
];
axios
.post(
"https://api.seermartech.cn/v3/dataforseo_labs/domain_rank_overview/live",
postData,
{
headers: {
Authorization: "Bearer smt_live_YOUR_KEY",
"Content-Type": "application/json",
},
}
)
.then((response) => {
// 处理响应数据
console.log(response.data);
})
.catch((error) => {
// 处理请求错误
console.error(error.response?.data || error.message);
});响应示例
json
{
"version": "0.1.20210601",
"status_code": 20000,
"status_message": "Ok.",
"time": "0.2826 sec.",
"cost": 0.0101,
"tasks_count": 1,
"tasks_error": 0,
"tasks": [
{
"id": "00000000-0000-0000-0000-000000000000",
"status_code": 20000,
"status_message": "Ok.",
"time": "0.2500 sec.",
"cost": 0.0101,
"result_count": 1,
"path": [
"v3",
"dataforseo_labs",
"domain_rank_overview",
"live"
],
"data": {
"api": "dataforseo_labs",
"function": "domain_rank_overview",
"target": "example.com",
"language_name": "English",
"location_code": 2840
},
"result": [
{
"target": "example.com",
"location_code": 2840,
"language_code": "en",
"total_count": 1,
"items_count": 1,
"items": [
{
"metrics": {
"organic": {
"pos_1": 12,
"pos_2_3": 25,
"pos_4_10": 88,
"pos_11_20": 120,
"pos_21_30": 96,
"pos_31_40": 72,
"pos_41_50": 51,
"pos_51_60": 43,
"pos_61_70": 35,
"pos_71_80": 24,
"pos_81_90": 18,
"pos_91_100": 11,
"etv": 12500.5,
"impressions_etv": 15800.2,
"count": 595,
"estimated_paid_traffic_cost": 3200.8,
"is_new": 34,
"is_up": 76,
"is_down": 41,
"is_lost": 12
},
"paid": {
"pos_1": 2,
"pos_2_3": 5,
"pos_4_10": 16,
"pos_11_20": 0,
"pos_21_30": 0,
"pos_31_40": 0,
"pos_41_50": 0,
"pos_51_60": 0,
"pos_61_70": 0,
"pos_71_80": 0,
"pos_81_90": 0,
"pos_91_100": 0,
"etv": 830.4,
"impressions_etv": 1020.6,
"count": 23,
"estimated_paid_traffic_cost": 1450.3,
"is_new": 3,
"is_up": 5,
"is_down": 2,
"is_lost": 1
}
}
}
]
}
]
}
]
}状态码与错误处理
请根据顶层 status_code 和任务级 status_code 判断请求是否成功。建议客户端对异常和错误状态进行统一处理,并记录以下信息:
- HTTP 状态码;
- API
status_code; status_message;- 任务
id; - 请求参数中的
tag。
当 tasks_error 大于 0 时,表示至少有一个任务处理失败,应逐项检查 tasks 数组中的任务状态。
实用场景
- 评估竞争域名的自然搜索覆盖度:统计各排名区间的数量,识别竞争对手的核心排名优势与潜在突破区间。
- 监测 SEO 项目排名变化:结合
is_new、is_up、is_down和is_lost,量化周期新增、提升、下降及丢失的排名。 - 估算自然流量与投放价值:使用
etv和estimated_paid_traffic_cost,评估自然搜索流量的商业价值及等效付费获取成本。 - 对比自然搜索与付费搜索表现:分别分析
organic和paid指标,判断域名的流量来源结构和搜索投放依赖度。 - 构建多地区 SEO 监控报表:按
location_code、language_code和tag批量查询不同市场,支持化 SEO 项目的排名对比与月度复盘。