API Hop 文件
Similarweb API 參考
Similarweb 端點的查詢參數、預設值與原生回應格式。
下列所有路徑皆相對於您的 API 來源網址。每個請求都需要 Authorization: Bearer YOUR_API_KEY,使用 GET,且不含請求主體。請參閱驗證、計費與錯誤。
查詢規則
單一網站欄位 key 和 Key 需要一個 ASCII 網域,例如 amazon.com,最多 253 個字元,前後不得有空白。請勿在這些欄位中傳送 URL、IP 位址、網域清單或 API 憑證。國際化網域請使用 punycode。
查詢名稱區分大小寫。未知欄位、重複欄位、CR/LF/NUL 和無效值會被拒絕。布林值必須是字面值 true 或 false;零不能代替 false。文字去除前後空白後,長度須為 1-2048 個 UTF-8 位元組。請使用 HTTP 用戶端的查詢編碼器編碼空白、JSON 陣列和分隔符號。
from 和 to 必須同時出現,是格式為 YYYY-MM-DD 或 YYYY|MM|DD 的實際日曆日期,且符合 from <= to。比較日期配對也遵循相同規則。選填欄位沿用端點預設值;表格列出允許的欄位,並不要求全部傳送。
對於接受日期的端點,合法、完整的明確 from/to 區間優先。對於接受 latest 的端點,傳入的值仍須通過原有格式和端點允許值驗證,但不再用於選擇區間,也不傳給 Similarweb;不補預設 latest。沒有明確區間時,原有 latest、預設值和視窗行為保持不變。History 的限制仍適用;不接受 latest 的端點仍拒絕該欄位。
未提供明確 from/to 區間時:以時間區間為基礎的路由通常預設為截至三個 UTC 日前的 28 天,接受 latest=1d 至 366d。固定月份路由的預設值如下所示。互動、造訪、排名及管道另接受 latest=1m|2m|3m|6m,代表先前完整的 UTC 日曆月份;這些選擇器要求 isWindow=false,並預設為 timeGranularity=Monthly。歷史資料的四個端點適用各自文件中較嚴格的規則。
僅支援全球資料(country=999)。 網站識別碼是 example.com 這類網域,但關鍵字排名端點的 keys 是搜尋關鍵字。上游資料可用性、篩選器和比對類型可能有所不同。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。
成功回應保留原生 JSON,而不採用統一的回應結構。流入與流出推薦表格使用 Records;歷史指標可能使用巢狀 Data。以下名稱和單位不代表每個上游選填欄位都一定存在。
端點
關鍵字建議
GET https://api.apihop.ai/v1/similarweb/keywords/suggestions
預設值:country 999、latest 28d、rowsPerPage 100、type Broad、websource Total,以及 windowVolume 遞減排序。選填的 page 從 1 開始。rangeFilter 使用原生語法,例如 volume,100,10000|difficulty,0,40。比對類型與篩選器的可用性取決於資料來源。 僅支援全球資料(country=999)。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keyword | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
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.apihop.ai/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.apihop.ai/v1/similarweb/websites/keywords
預設值:page 1、pageSize 100、sourceType all,且兩個品牌旗標皆為 false。pageFilterJson 是單一經 URL 編碼的 JSON 陣列字串;省略時會將 keys 視為網域。未提供明確 from/to 區間時:latest=1m 選擇單月總覽模式,除非明確指定,否則 pageSize 為 5 且 isWindow=false。非品牌關鍵字檢視請使用 sourceType=organic 或 paid,搭配 IncludeNoneBranded=true 和 IncludeBranded=false。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
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.apihop.ai/v1/similarweb/keywords/websites
keys 是關鍵字,而非網站網域。預設值包括 selectedPageTab=Organic、sourceType=organic、Device=Total 和 graphDuration=28d。選填的 page 從 1 開始,pageSize 使用正整數。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
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.apihop.ai/v1/similarweb/websites/traffic-sources
預設值:sourceType=Referral、page=1、orderBy=Share desc 和 timeGranularity=Daily。此表格與流入推薦端點不同。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
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.apihop.ai/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 是上游總數,而非目前頁面的長度。 僅支援全球資料(country=999)。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
key | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
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.apihop.ai/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。 僅支援全球資料(country=999)。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
key | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
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.apihop.ai/v1/similarweb/websites/branded-keywords
預設為前一個完整的 UTC 月份。duration 固定為 1m。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
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.apihop.ai/v1/similarweb/websites/geography
預設為前三個完整的 UTC 月份,pageSize=5 且 orderBy=TotalShare desc。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
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.apihop.ai/v1/similarweb/websites/devices
預設為前三個完整的 UTC 月份,且 ShouldGetVerifiedData=false。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
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.apihop.ai/v1/similarweb/websites/search-performance
預設為前一個完整的 UTC 月份,pageSize=5、duration=1m 且 SourceType=Organic。付費關鍵字請使用 SourceType=Paid;請勿以 sourceType 取代。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
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.apihop.ai/v1/similarweb/websites/social-traffic
預設為前三個完整的 UTC 月份。不接受 webSource。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
from | 否 | 字串;使用上述格式的有效日期 |
to | 否 | 字串;使用上述格式的有效日期 |
includeSubDomains | 否 | 布林字串:true 或 false |
isWindow | 否 | 布林字串:true 或 false |
timeGranularity | 否 | 字串;列舉值:Daily, Monthly |
latest | 否 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
互動總覽
GET https://api.apihop.ai/v1/similarweb/websites/engagement
預設值包括 ShouldGetVerifiedData=false、includeLeaders=true 和 unBounced=false。原生 Data 資料列可能包含 AvgMonthVisits、BounceRate、PagesPerVisit 和 AvgVisitDuration。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
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.apihop.ai/v1/similarweb/websites/visits
compareFrom 和 compareTo 必須一同提供,且為順序正確的有效日期。timeGranularity 為 Monthly。原生欄位可能包含 TotalVisits、Change 和 ShareOfVisits;滾動總數不一定等於完整日曆月的總數。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
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.apihop.ai/v1/similarweb/websites/visits/table
compareFrom 和 compareTo 必須一同提供,且為順序正確的有效日期。timeGranularity 為 Monthly;資料列位於 Data,包含 Domain 和 TotalVisits。即使 Data 含有資料列,TotalCount 仍可能為 0;請檢查陣列本身以判斷是否有結果。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
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.apihop.ai/v1/similarweb/websites/visits/trend
預設為按日統計的滾動 28 天區間。timeGranularity 接受 Daily、Weekly 或 Monthly。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
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.apihop.ai/v1/similarweb/websites/ranks
timeGranularity 為 Monthly。原生回應使用各自獨立的 GlobalRank、CountryRank 和 CategoryRank 物件。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
from | 否 | 字串;使用上述格式的有效日期 |
to | 否 | 字串;使用上述格式的有效日期 |
includeSubDomains | 否 | 布林字串:true 或 false |
isWindow | 否 | 布林字串:true 或 false |
webSource | 否 | 字串;列舉值:Total, Desktop, MobileWeb |
timeGranularity | 否 | 字串;列舉值:Monthly |
latest | 否 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
國家排名
GET https://api.apihop.ai/v1/similarweb/websites/ranks/country
timeGranularity 為 Monthly。這是明確的國家排名表格,而非合併的排名回應。資料列位於 Data,包含 Domain 和 Rank。即使有資料列,TotalCount 仍可能為 0;請直接檢查 Data。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
from | 否 | 字串;使用上述格式的有效日期 |
to | 否 | 字串;使用上述格式的有效日期 |
includeSubDomains | 否 | 布林字串:true 或 false |
isWindow | 否 | 布林字串:true 或 false |
webSource | 否 | 字串;列舉值:Total, Desktop, MobileWeb |
timeGranularity | 否 | 字串;列舉值:Monthly |
latest | 否 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
全球排名
GET https://api.apihop.ai/v1/similarweb/websites/ranks/global
timeGranularity 為 Monthly。此端點回傳獨立的全球排名表格。資料列位於 Data,包含 Domain 和 Rank。即使有資料列,TotalCount 仍可能為 0;請直接檢查 Data。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
from | 否 | 字串;使用上述格式的有效日期 |
to | 否 | 字串;使用上述格式的有效日期 |
includeSubDomains | 否 | 布林字串:true 或 false |
isWindow | 否 | 布林字串:true 或 false |
webSource | 否 | 字串;列舉值:Total, Desktop, MobileWeb |
timeGranularity | 否 | 字串;列舉值:Monthly |
latest | 否 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
分類排名
GET https://api.apihop.ai/v1/similarweb/websites/ranks/category
timeGranularity 為 Monthly。此端點回傳獨立的產業/分類排名表格。資料列位於 Data,包含 Domain 和 Rank。即使有資料列,TotalCount 仍可能為 0;請直接檢查 Data。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
from | 否 | 字串;使用上述格式的有效日期 |
to | 否 | 字串;使用上述格式的有效日期 |
includeSubDomains | 否 | 布林字串:true 或 false |
isWindow | 否 | 布林字串:true 或 false |
webSource | 否 | 字串;列舉值:Total, Desktop, MobileWeb |
timeGranularity | 否 | 字串;列舉值:Monthly |
latest | 否 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
流量管道
GET https://api.apihop.ai/v1/similarweb/websites/channels
預設為按日統計的滾動 28 天區間。當 webSource=Total 時,管道值位於 Data.Total[domain] 下,而非直接位於 Data[domain] 下。管道名稱會保留,例如 Search - Organic 和 Direct。數值代表造訪次數;僅在總和為正時推算占比。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
from | 否 | 字串;使用上述格式的有效日期 |
to | 否 | 字串;使用上述格式的有效日期 |
includeSubDomains | 否 | 布林字串:true 或 false |
isWindow | 否 | 布林字串:true 或 false |
webSource | 否 | 字串;列舉值:Total, Desktop, MobileWeb |
timeGranularity | 否 | 字串;列舉值:Daily, Monthly |
latest | 否 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
相似網站
GET https://api.apihop.ai/v1/similarweb/websites/similar-sites
預設為前三個完整的 UTC 月份。isWindow 必須為 false,timeGranularity 為 Monthly,orderBy 固定為 Affinity desc。不接受 latest 或 webSource。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
from | 否 | 字串;使用上述格式的有效日期 |
to | 否 | 字串;使用上述格式的有效日期 |
includeSubDomains | 否 | 布林字串:true 或 false |
isWindow | 否 | 布林字串:true 或 false |
timeGranularity | 否 | 字串;列舉值:Monthly |
orderBy | 否 | 字串;列舉值:Affinity desc |
相似網站建議
GET https://api.apihop.ai/v1/similarweb/websites/similar-sites/suggestions
使用單數 key;limit 預設為 20,且必須為 1-20。country 預設為 999,webSource 預設為 Total。觀察到的原生回應是未包裝的候選陣列,包含 Domain、DomainWithoutSub、數值型 Rank 和 Favicon;請勿預期有 Data 外層。空陣列表示沒有建議。 僅支援全球資料(country=999)。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
key | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
limit | 否 | 整數字串;1-20 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
webSource | 否 | 字串;列舉值:Total, Desktop, MobileWeb |
每月造訪歷史
GET https://api.apihop.ai/v1/similarweb/websites/history/visits
預設為前六個完整的 UTC 月份。僅支援 country=999、isWindow=false 和 timeGranularity=Monthly。latest 接受 1m 至 6m;明確指定的日期必須涵蓋此滾動六個月區間內的完整月份。原生序列可能位於 Data.<domain>.<source> 下,包含 Key/Value 資料點;來源名稱(包括 MobileWeb 或 Mobile Web)會保留。數值代表估計造訪次數。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
from | 否 | 字串;使用上述格式的有效日期 |
to | 否 | 字串;使用上述格式的有效日期 |
includeSubDomains | 否 | 布林字串:true 或 false |
isWindow | 否 | 布林字串:true 或 false |
webSource | 否 | 字串;列舉值:Total, Desktop, MobileWeb |
timeGranularity | 否 | 字串;列舉值:Monthly |
latest | 否 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
每月跳出率歷史
GET https://api.apihop.ai/v1/similarweb/websites/history/bounce-rate
預設為前六個完整的 UTC 月份。僅支援 country=999、isWindow=false 和 timeGranularity=Monthly。latest 接受 1m 至 6m;明確指定的日期必須涵蓋此滾動六個月區間內的完整月份。原生序列可能位於 Data.<domain>.<source> 下,包含 Key/Value 資料點;來源名稱(包括 MobileWeb 或 Mobile Web)會保留。數值代表以小數表示的跳出率。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
from | 否 | 字串;使用上述格式的有效日期 |
to | 否 | 字串;使用上述格式的有效日期 |
includeSubDomains | 否 | 布林字串:true 或 false |
isWindow | 否 | 布林字串:true 或 false |
webSource | 否 | 字串;列舉值:Total, Desktop, MobileWeb |
timeGranularity | 否 | 字串;列舉值:Monthly |
latest | 否 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
每月造訪時間歷史
GET https://api.apihop.ai/v1/similarweb/websites/history/visit-duration
預設為前六個完整的 UTC 月份。僅支援 country=999、isWindow=false 和 timeGranularity=Monthly。latest 接受 1m 至 6m;明確指定的日期必須涵蓋此滾動六個月區間內的完整月份。原生序列可能位於 Data.<domain>.<source> 下,包含 Key/Value 資料點;來源名稱(包括 MobileWeb 或 Mobile Web)會保留。數值代表每次造訪的秒數。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
from | 否 | 字串;使用上述格式的有效日期 |
to | 否 | 字串;使用上述格式的有效日期 |
includeSubDomains | 否 | 布林字串:true 或 false |
isWindow | 否 | 布林字串:true 或 false |
webSource | 否 | 字串;列舉值:Total, Desktop, MobileWeb |
timeGranularity | 否 | 字串;列舉值:Monthly |
latest | 否 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
每月每次造訪頁數歷史
GET https://api.apihop.ai/v1/similarweb/websites/history/pages-per-visit
預設為前六個完整的 UTC 月份。僅支援 country=999、isWindow=false 和 timeGranularity=Monthly。latest 接受 1m 至 6m;明確指定的日期必須涵蓋此滾動六個月區間內的完整月份。原生序列可能位於 Data.<domain>.<source> 下,包含 Key/Value 資料點;來源名稱(包括 MobileWeb 或 Mobile Web)會保留。數值代表每次造訪的頁數。
| 查詢欄位 | 必填 | 類型與限制 |
|---|---|---|
keys | 是 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |
country | 否 | 非負整數字串; 僅支援全球資料(country=999)。 其他合法的國家參數值在請求上游前統一改為 999,傳回全球資料,而非所指定國家的資料。 |
from | 否 | 字串;使用上述格式的有效日期 |
to | 否 | 字串;使用上述格式的有效日期 |
includeSubDomains | 否 | 布林字串:true 或 false |
isWindow | 否 | 布林字串:true 或 false |
webSource | 否 | 字串;列舉值:Total, Desktop, MobileWeb |
timeGranularity | 否 | 字串;列舉值:Monthly |
latest | 否 | 字串;去除前後空白後為 1-2048 個 UTF-8 位元組 |