RequestBeam 文档
SimilarwebAPI 接口参考
27 个 SimilarwebAPI GET 接口的完整参数名、类型、限制、时间范围及响应语义。
以下路径均相对于你的 API 域名。所有请求必须带上 Authorization: Bearer YOUR_API_KEY，使用 GET，且不传请求体。鉴权、计费与错误说明。
参数规则
网站单值字段 key 和 Key 必须是一个 ASCII 域名，例如 amazon.com，最长 253 个字符，且不含首尾空白。不能传 URL、IP 地址、域名列表或 API 凭据；国际化域名请使用 punycode。
Query 字段名区分大小写。未知字段、重复字段、CR/LF/NUL 及非法值会被拒绝。布尔值必须是字面量 true 或 false，不能用数字代替。文本去除首尾空白后为 1-2048 UTF-8 字节。空格、JSON 数组和分隔符应交给 HTTP 客户端的 query 编码器处理。
from 与 to 必须同时提供真实日期，格式为 YYYY-MM-DD 或 YYYY|MM|DD，且 from <= to。比较日期对遵循同样规则。不要同时传显式日期与 latest。可选字段省略时使用接口默认值；参数表列出允许字段，并不表示需要全部传入。
滚动窗口接口通常默认查询截至 UTC 三天前的 28 天，支持 latest=1d 至 366d。固定月份接口的默认值见对应说明。互动概览、访问量、排名和渠道还支持 latest=1m|2m|3m|6m，表示前几个完整 UTC 自然月；此模式要求 isWindow=false，默认 timeGranularity=Monthly。历史接口限制更严格，见对应四个接口说明。
国家代码 999 表示全球，0 会保留。网站标识使用 example.com 这样的域名；关键词排名接口的 keys 则是搜索关键词。数据覆盖、筛选和匹配类型的可用性可能因数据源而异。
成功响应保持原生 JSON，不统一改造成同一种结构。入站引荐与出站流量表使用 Records，历史指标可能使用嵌套 Data。以下列出的字段和单位不保证每次响应均含所有可选上游字段。
接口列表
关键词建议
GET https://api.requestbeam.com/v1/similarweb/keywords/suggestions
默认 country=999、latest=28d、rowsPerPage=100、type=Broad、websource=Total，按 windowVolume 降序排列。page 从 1 开始。rangeFilter 使用原生语法，例如 volume,100,10000|difficulty,0,40。匹配类型和筛选条件是否可用取决于数据源。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keyword | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
sort | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
asc | 否 | 布尔字符串：true 或 false |
page | 否 | 整数字符串；1-1000 |
rowsPerPage | 否 | 整数字符串；1-1000 |
type | 否 | 字符串；枚举：Broad, Phrase, Exact, Related |
websource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
isWindow | 否 | 布尔字符串：true 或 false |
rangeFilter | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
网站外链
GET https://api.requestbeam.com/v1/similarweb/websites/backlinks
默认 Page=1、PageSize=100、Status=All、FollowType=All，按 DomainScore 降序排列。Key 的首字母必须大写，不能使用 key 或 keys。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
Key | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
Page | 否 | 整数字符串；1-1000 |
PageSize | 否 | 整数字符串；1-1000 |
Status | 否 | 字符串；枚举：All, Active, New, Lost |
FollowType | 否 | 字符串；枚举：All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow |
DomainScoreFrom | 否 | 整数字符串；0-100 |
DomainScoreTo | 否 | 整数字符串；0-100 |
sort | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
asc | 否 | 布尔字符串：true 或 false |
网站流量关键词
GET https://api.requestbeam.com/v1/similarweb/websites/keywords
默认 page=1、pageSize=100、sourceType=all，两项品牌词标记均为 false。pageFilterJson 是经过 URL 编码的 JSON 数组字符串；省略时按域名 keys 查询。latest=1m 选择月度概览模式，未显式传入时使用 pageSize=5、isWindow=false。非品牌词可使用 sourceType=organic 或 paid，配合 IncludeNoneBranded=true、IncludeBranded=false。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Daily, Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
sort | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
asc | 否 | 布尔字符串：true 或 false |
iso | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
isDaily | 否 | 布尔字符串：true 或 false |
IncludeBranded | 否 | 布尔字符串：true 或 false |
IncludeNoneBranded | 否 | 布尔字符串：true 或 false |
page | 否 | 整数字符串；1-1000 |
pageSize | 否 | 整数字符串；1-1000 |
sourceType | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
pageFilterJson | 否 | 包含 JSON 数组的字符串 |
关键词排名网站
GET https://api.requestbeam.com/v1/similarweb/keywords/websites
keys 表示关键词，不是网站域名。默认 selectedPageTab=Organic、sourceType=organic、Device=Total、graphDuration=28d。可选 page 从 1 开始，pageSize 为正整数。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Daily, Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
sort | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
asc | 否 | 布尔字符串：true 或 false |
iso | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
isDaily | 否 | 布尔字符串：true 或 false |
tab | 否 | 非负整数字符串 |
mtd | 否 | 布尔字符串：true 或 false |
selectedPageTab | 否 | 字符串；枚举：Organic, Paid |
graphDuration | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
graphType | 否 | 整数字符串；1-1000 |
isDurationChanged | 否 | 布尔字符串：true 或 false |
ignoreFilterConsistency | 否 | 布尔字符串：true 或 false |
Device | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
sourceType | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
page | 否 | 整数字符串；1-1000 |
pageSize | 否 | 整数字符串；1-1000 |
流量来源
GET https://api.requestbeam.com/v1/similarweb/websites/traffic-sources
默认 sourceType=Referral、page=1、orderBy=Share desc、timeGranularity=Daily。本表与 incoming-referrals 接口不同。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Daily, Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
sourceType | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
ignoreFilterConsistency | 否 | 布尔字符串：true 或 false |
page | 否 | 整数字符串；1-1000 |
orderBy | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
出站流量
GET https://api.requestbeam.com/v1/similarweb/websites/outgoing-traffic
from 和 to 必填，只接受单数 key。默认 country=999、isWWW=false、isWindow=false、webSource=Total、page=1、orderby=Share desc、orderBy=Share desc、sort=Share、asc=false。orderby 与 orderBy 是两个独立字段，请保持排序条件一致。不接受 latest、pageSize、rowsPerPage、includeSubDomains 或 timeGranularity。结果行在 Records；TotalCount 是上游总数，不是当前页行数。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
key | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 是 | 字符串；有效日期，格式见上方规则 |
to | 是 | 字符串；有效日期，格式见上方规则 |
isWWW | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
orderby | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
orderBy | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
sort | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
asc | 否 | 布尔字符串：true 或 false |
page | 否 | 整数字符串；1-1000 |
入站引荐流量
GET https://api.requestbeam.com/v1/similarweb/websites/incoming-referrals
只接受单数 key。默认 country=999、latest=28d、isWWW=false、isWindow=true、isDaily=false、webSource=Total、selectedTab=incomingTraffic、orderBy=TotalShare desc、ignoreFilterConsistency=false、page=1。不接受 keys、pageSize、rowsPerPage、includeSubDomains 或 timeGranularity。结果行在 Records，原生字段可能包含 SiteOrigins 和 TotalShare。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
key | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
isWWW | 否 | 布尔字符串：true 或 false |
iso | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
isWindow | 否 | 布尔字符串：true 或 false |
isDaily | 否 | 布尔字符串：true 或 false |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
selectedTab | 否 | 字符串；枚举：incomingTraffic |
orderBy | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
ignoreFilterConsistency | 否 | 布尔字符串：true 或 false |
page | 否 | 整数字符串；1-1000 |
品牌词占比
GET https://api.requestbeam.com/v1/similarweb/websites/branded-keywords
默认查询上一个完整 UTC 自然月，duration 固定为 1m。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Daily, Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
duration | 否 | 字符串；枚举：1m |
流量地域
GET https://api.requestbeam.com/v1/similarweb/websites/geography
默认查询前 3 个完整 UTC 自然月，pageSize=5、orderBy=TotalShare desc。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Daily, Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
pageSize | 否 | 整数字符串；1-1000 |
orderBy | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
设备分布
GET https://api.requestbeam.com/v1/similarweb/websites/devices
默认查询前 3 个完整 UTC 自然月，ShouldGetVerifiedData=false。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Daily, Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
ShouldGetVerifiedData | 否 | 布尔字符串：true 或 false |
搜索表现
GET https://api.requestbeam.com/v1/similarweb/websites/search-performance
默认查询上一个完整 UTC 自然月，pageSize=5、duration=1m、SourceType=Organic。付费搜索使用 SourceType=Paid，不要改为 sourceType。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Daily, Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
pageSize | 否 | 整数字符串；1-1000 |
duration | 否 | 字符串；枚举：1m |
SourceType | 否 | 字符串；枚举：Organic, Paid |
社交流量
GET https://api.requestbeam.com/v1/similarweb/websites/social-traffic
默认查询前 3 个完整 UTC 自然月，不接受 webSource。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
timeGranularity | 否 | 字符串；枚举：Daily, Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
互动指标概览
GET https://api.requestbeam.com/v1/similarweb/websites/engagement
默认 ShouldGetVerifiedData=false、includeLeaders=true、unBounced=false。原生 Data 行可能包含 AvgMonthVisits、BounceRate、PagesPerVisit、AvgVisitDuration。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Daily, Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
ShouldGetVerifiedData | 否 | 布尔字符串：true 或 false |
includeLeaders | 否 | 布尔字符串：true 或 false |
unBounced | 否 | 布尔字符串：true 或 false |
beta | 否 | 布尔字符串：true 或 false |
总访问量
GET https://api.requestbeam.com/v1/similarweb/websites/visits
compareFrom 和 compareTo 必须同时传入有效且有序的日期。timeGranularity 固定 Monthly。原生字段可能包含 TotalVisits、Change、ShareOfVisits；滚动窗口总量不等于完整自然月总量。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
compareFrom | 否 | 字符串；有效日期，格式见上方规则 |
compareTo | 否 | 字符串；有效日期，格式见上方规则 |
ShouldGetVerifiedData | 否 | 布尔字符串：true 或 false |
访问量表格
GET https://api.requestbeam.com/v1/similarweb/websites/visits/table
compareFrom 和 compareTo 必须同时传入有效且有序的日期。timeGranularity 固定 Monthly，结果行位于 Data，包含 Domain 和 TotalVisits。即使 Data 中存在结果行，TotalCount 也可能为 0；请直接检查数组判断是否有数据。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
compareFrom | 否 | 字符串；有效日期，格式见上方规则 |
compareTo | 否 | 字符串；有效日期，格式见上方规则 |
ShouldGetVerifiedData | 否 | 布尔字符串：true 或 false |
访问量趋势
GET https://api.requestbeam.com/v1/similarweb/websites/visits/trend
默认查询 28 天滚动窗口并按日返回。timeGranularity 支持 Daily、Weekly 或 Monthly。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Daily, Weekly, Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
ShouldGetVerifiedData | 否 | 布尔字符串：true 或 false |
网站排名
GET https://api.requestbeam.com/v1/similarweb/websites/ranks
timeGranularity 固定 Monthly，原生响应使用独立的 GlobalRank、CountryRank、CategoryRank 对象。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
国家排名
GET https://api.requestbeam.com/v1/similarweb/websites/ranks/country
timeGranularity 固定 Monthly，这是独立的国家排名表，不是综合排名响应。结果行位于 Data，包含 Domain 和 Rank。即使有结果行，TotalCount 也可能为 0；请直接检查 Data。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
全球排名
GET https://api.requestbeam.com/v1/similarweb/websites/ranks/global
timeGranularity 固定 Monthly，返回独立的全球排名表。结果行位于 Data，包含 Domain 和 Rank。即使有结果行，TotalCount 也可能为 0；请直接检查 Data。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
行业排名
GET https://api.requestbeam.com/v1/similarweb/websites/ranks/category
timeGranularity 固定 Monthly，返回独立的行业/类别排名表。结果行位于 Data，包含 Domain 和 Rank。即使有结果行，TotalCount 也可能为 0；请直接检查 Data。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
流量渠道
GET https://api.requestbeam.com/v1/similarweb/websites/channels
默认查询 28 天滚动窗口并按日统计。使用 webSource=Total 时，渠道数值位于 Data.Total[domain]，并非直接位于 Data[domain]。渠道名称原样保留，例如 Search - Organic 和 Direct。数值表示访问次数，仅在其总和为正时计算占比。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Daily, Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
相似网站
GET https://api.requestbeam.com/v1/similarweb/websites/similar-sites
默认查询前 3 个完整 UTC 自然月。isWindow 必须为 false，timeGranularity 固定 Monthly，orderBy 固定 Affinity desc。不接受 latest 或 webSource。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
timeGranularity | 否 | 字符串；枚举：Monthly |
orderBy | 否 | 字符串；枚举：Affinity desc |
相似网站建议
GET https://api.requestbeam.com/v1/similarweb/websites/similar-sites/suggestions
使用单数 key。limit 默认 20，范围 1-20；country 默认 999，webSource 默认 Total。已观察到的原生响应为不带包装的候选数组，每项包含 Domain、DomainWithoutSub、数值类型的 Rank 和 Favicon，没有 Data 包装层。空数组表示没有建议结果。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
key | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
limit | 否 | 整数字符串；1-20 |
country | 否 | 非负整数字符串 |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
月度访问量历史
GET https://api.requestbeam.com/v1/similarweb/websites/history/visits
默认查询前 6 个完整 UTC 自然月。仅支持 country=999、isWindow=false、timeGranularity=Monthly。latest 支持 1m 至 6m；显式日期须为该滚动 6 月范围内的完整自然月。原生序列可能位于 Data.<domain>.<source>，使用 Key/Value 点；MobileWeb 或 Mobile Web 等来源名原样保留。 数值单位为估算访问次数。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
月度跳出率历史
GET https://api.requestbeam.com/v1/similarweb/websites/history/bounce-rate
默认查询前 6 个完整 UTC 自然月。仅支持 country=999、isWindow=false、timeGranularity=Monthly。latest 支持 1m 至 6m；显式日期须为该滚动 6 月范围内的完整自然月。原生序列可能位于 Data.<domain>.<source>，使用 Key/Value 点；MobileWeb 或 Mobile Web 等来源名原样保留。 数值单位为跳出率比例。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
月度访问时长历史
GET https://api.requestbeam.com/v1/similarweb/websites/history/visit-duration
默认查询前 6 个完整 UTC 自然月。仅支持 country=999、isWindow=false、timeGranularity=Monthly。latest 支持 1m 至 6m；显式日期须为该滚动 6 月范围内的完整自然月。原生序列可能位于 Data.<domain>.<source>，使用 Key/Value 点；MobileWeb 或 Mobile Web 等来源名原样保留。 数值单位为每次访问秒数。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
月度每次访问页数历史
GET https://api.requestbeam.com/v1/similarweb/websites/history/pages-per-visit
默认查询前 6 个完整 UTC 自然月。仅支持 country=999、isWindow=false、timeGranularity=Monthly。latest 支持 1m 至 6m；显式日期须为该滚动 6 月范围内的完整自然月。原生序列可能位于 Data.<domain>.<source>，使用 Key/Value 点；MobileWeb 或 Mobile Web 等来源名原样保留。 数值单位为每次访问页数。
| 参数 | 必填 | 类型与限制 |
|---|---|---|
keys | 是 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |
country | 否 | 非负整数字符串 |
from | 否 | 字符串；有效日期，格式见上方规则 |
to | 否 | 字符串；有效日期，格式见上方规则 |
includeSubDomains | 否 | 布尔字符串：true 或 false |
isWindow | 否 | 布尔字符串：true 或 false |
webSource | 否 | 字符串；枚举：Total, Desktop, MobileWeb |
timeGranularity | 否 | 字符串；枚举：Monthly |
latest | 否 | 字符串；去除首尾空白后 1-2048 UTF-8 字节 |