主题
domain_analytics/whois/filters/
本页介绍 Domain Analytics Whois API 可使用的结果过滤器。过滤器与响应中 result 数组的对象,根据目标接口返回的数据结构进行。
接口信息
GET /v3/domain_analytics/whois/available_filters
该接口用于获取 Domain Analytics Whois API 支持的完整过滤器列表。
本接口不收取调用费用。
请求示例
bash
curl --location --request GET \
'https://api.seermartech.cn/v3/domain_analytics/whois/available_filters' \
--header 'Authorization: Bearer smt_live_YOUR_KEY'响应说明
接口返回 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 | 任务列表 |
tasks 子项字段
| 字段 | 类型 | 说明 |
|---|---|---|
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 | GET 请求 URL 中传的参数 |
result | array | 可用过滤器列表,过滤器按适用端点分组 |
响应示例
json
{
"version": "0.1.20220819",
"status_code": 20000,
"status_message": "Ok.",
"time": "0.0594 sec.",
"cost": 0,
"tasks_count": 1,
"tasks_error": 0,
"tasks": [
{
"id": "00000000-0000-0000-0000-000000000000",
"status_code": 20000,
"status_message": "Ok.",
"time": "0.0594 sec.",
"cost": 0,
"result_count": 1,
"path": [
"v3",
"domain_analytics",
"whois",
"available_filters"
],
"data": {
"api": "domain_analytics",
"function": "available_filters",
"se": "whois"
},
"result": [
{
"endpoint": "domain_analytics/whois/overview/live",
"filters": []
}
]
}
]
}过滤器结构
过滤器通过 filters 字段传。过滤器通常用于请求接口的 POST 请求体中,并且匹对应接口 result 数组中的字段路径。
filters
| 字段 | 类型 | 填 | 说明 |
|---|---|---|---|
filters | array | 否 | 结果过滤条件数组,最多支持 8 个过滤条件。多个条件之间使用逻辑运算符 and 或 or 连接 |
单个过滤条件的结构如下:
json
[
"$item_array.$results_array.$parameter_field",
"$filter_operator",
"$filter_value"
]例如:
json
[
"keyword_data.keyword",
"like",
"%seo%"
]多个过滤条件示例:
json
[
[
"keyword_data.keyword",
"like",
"%seo%"
],
"and",
[
"keyword_data.keyword_info.search_volume",
">",
100
]
]过滤器路径使用 . 连接对象层级;字段以目标接口返回的字段结构为准。
过滤器字段
$item_array
| 类型 | 填 | 说明 |
|---|---|---|
| string | 否 | 过滤器中的项目名称 |
可用值:
keyword_dataranked_serp_element
$results_array
| 类型 | 填 | 说明 |
|---|---|---|
| string | 否 | 过滤器中结果数组的名称 |
可用值:
keywordkeyword_infocheck_urlse_results_countserp_itemmetrics
$parameter_field
| 类型 | 填 | 说明 |
|---|---|---|
| string | 过滤器启用时填 | 要进行筛选的参数字段。该字段存在于对应的 $results_array 或 $item_array 中 |
示例:
text
keyword_data.keyword_info.search_volume$filter_operator
| 字段类型 | 可用运算符 |
|---|---|
bool | =、<> |
num | <、<=、>、>=、=、<>、in、not_in |
str | like、not_like、in、not_in、=、<>、regex、not_regex |
array.str | has、has_not |
array.num | has、has_not |
time | <、> |
时间字段使用以下格式:
text
yyyy-mm-dd hh-mm-ss +00:00示例:
text
2021-01-29 15:02:37 +00:00$filter_value
| 类型 | 填 | 说明 |
|---|---|---|
num、str、bool、array.str | 过滤器启用时填 | 过滤条件的匹值 |
in 和 not_in
使用 in 或 not_in 时,过滤值以数组形式传:
json
[
"keyword_data.keyword",
"in",
["seo", "marketing", "analytics"]
]regex 和 not_regex
regex 和 not_regex 支持使用字符串形式的 RE2 正则表达式。
正则表达式最大长度为 1000 个字符。
like 和 not_like
使用 like 和 not_like 时,建议在匹值中 % 通符,以获得准确结果。
返回 keyword_data 中 domain 字段 seo 的项目:
json
[
"keyword_data.domain",
"like",
"%seo%"
]排除 domain 字段 seo 的项目:
json
[
"keyword_data.domain",
"not_like",
"%seo%"
]过滤器适用端点
可用过滤器列表对应以下端点:
/v3/domain_analytics/whois/overview/live
请通过本页接口获取完整过滤器列表,再根据目标端点的返回字段过滤条件。过滤器应用于目标接口返回的字段,否则可能导致请求失败或无法匹结果。
计费说明
本接口为接口,不产生调用费用。
扣费以响应头 X-SeerMarTech-Charge-CNY 为准。
错误处理
请根据以下字段判断请求是否成功:
- 顶层
status_code - 任务级
tasks[].status_code - 顶层或任务级
status_message
当 status_code 不为成功状态码时,应结合对应的状态说明排查请求路径、认证信息、过滤器字段和运算符。
实用场景
- 获取 Whois 概览接口支持的过滤字段,因字段名称或层级错误导致筛选失败。
- 筛选含特定的域名结果,快速定位与 SEO、营销或品牌词的域名资产。
- 排除含指定字符串的域名,理品牌保护、竞品监控或域名研究中的无结果。
- 组合 搜索量、文本等多个条件,缩小分析范围并提高域名研究效率。
- 校验 时间、数值、数组和正则表达式等不同类型字段的可用运算符,构建更精确的 Whois 数据筛选逻辑。