Tham chiếu điểm cuối SimilarwebAPI | Tài liệu API

# SimilarwebAPI endpoint reference

All 27 SimilarwebAPI GET endpoints with exact query names, types, limits, date windows, and response behavior.

All paths below are relative to your API origin. Every request requires `Authorization: Bearer YOUR_API_KEY`, uses GET, and has no request body. See [authentication, billing, and errors](https://apihop.ai/en/docs/api-reference/similarweb/overview).

## Query Rules

The singular website fields `key` and `Key` require one ASCII domain such as `amazon.com`, up to 253 characters, without surrounding whitespace. Do not send a URL, IP address, domain list, or API credential in these fields. Use punycode for internationalized domains.

Query names are case-sensitive. Unknown fields, duplicate fields, CR/LF/NUL, and invalid values are rejected. Boolean values are literal `true` or `false`; zero is not interchangeable with false. Text is 1-2048 UTF-8 bytes after trimming. Encode spaces, JSON arrays, and separators with your HTTP client's query encoder.

`from` and `to` must occur together, be real calendar dates in `YYYY-MM-DD` or `YYYY|MM|DD` format, and satisfy `from <= to`. A comparison pair follows the same rule. Optional fields inherit endpoint defaults; the tables list allowed fields, not a requirement to send all of them.

For endpoints that accept dates, a valid, complete explicit `from`/`to` range takes precedence. On endpoints that accept `latest`, a supplied value must still pass the existing format and endpoint-specific validation, but is ignored for range selection and is not sent to Similarweb; no default `latest` is added. Without an explicit range, existing `latest`, default and window behavior is unchanged. History restrictions still apply, and endpoints that do not accept `latest` still reject it.

Without an explicit `from`/`to` range: Window-based routes normally default to 28 days ending three UTC days ago and accept `latest=1d` through `366d`. Fixed-month routes have the defaults noted below. Engagement, visits, ranks, and channels additionally accept `latest=1m|2m|3m|6m` for previous complete UTC calendar months; these selectors require `isWindow=false` and default `timeGranularity=Monthly`. History has the narrower rules documented for its four endpoints.

Only worldwide data is supported (`country=999`). Website identifiers are domains such as `example.com`, except the keyword-ranking endpoint where `keys` is a search keyword. Upstream data availability, filters, and matching types may vary. Other valid country values are changed to `999` before the upstream request and return worldwide, not country-specific, data.

Successful responses preserve native JSON rather than adopting a universal response schema. Incoming and outgoing referral tables use `Records`; historical metrics may use nested `Data`. The names and units described below do not imply every optional upstream field is always present.

## Endpoints

### Keyword suggestions

`GET https://api.apihop.ai/v1/similarweb/keywords/suggestions`

Defaults: country 999, latest 28d, rowsPerPage 100, type Broad, websource Total, and windowVolume descending. Optional page is 1-based. rangeFilter uses native syntax, for example volume,100,10000|difficulty,0,40. Matching-type and filter availability depend on the data source. Only worldwide data is supported (`country=999`).

| Query field | Required | Type and constraints |
| --- | --- | --- |
| `keyword` | Yes | string; 1-2048 UTF-8 bytes after trimming |
| `country` | No | nonnegative integer string; Only worldwide data is supported (`country=999`). Other valid country values are changed to `999` before the upstream request and return worldwide, not country-specific, data. |
| `from` | No | string; valid date using the formats above |
| `to` | No | string; valid date using the formats above |
| `latest` | No | string; 1-2048 UTF-8 bytes after trimming |
| `sort` | No | string; 1-2048 UTF-8 bytes after trimming |
| `asc` | No | boolean string: true or false |
| `page` | No | integer string; 1-1000 |
| `rowsPerPage` | No | integer string; 1-1000 |
| `type` | No | string; enum: Broad, Phrase, Exact, Related |
| `websource` | No | string; enum: Total, Desktop, MobileWeb |
| `isWindow` | No | boolean string: true or false |
| `rangeFilter` | No | string; 1-2048 UTF-8 bytes after trimming |

### Backlinks

`GET https://api.apihop.ai/v1/similarweb/websites/backlinks`

Defaults: Page 1, PageSize 100, Status All, FollowType All, and DomainScore descending. Key is capitalized; do not use key or keys.

| Query field | Required | Type and constraints |
| --- | --- | --- |
| `Key` | Yes | string; 1-2048 UTF-8 bytes after trimming |
| `Page` | No | integer string; 1-1000 |
| `PageSize` | No | integer string; 1-1000 |
| `Status` | No | string; enum: All, Active, New, Lost |
| `FollowType` | No | string; enum: All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow |
| `DomainScoreFrom` | No | integer string; 0-100 |
| `DomainScoreTo` | No | integer string; 0-100 |
| `sort` | No | string; 1-2048 UTF-8 bytes after trimming |
| `asc` | No | boolean string: true or false |

### Website keywords

`GET https://api.apihop.ai/v1/similarweb/websites/keywords`

Defaults: page 1, pageSize 100, sourceType all, and both branded flags false. pageFilterJson is one URL-encoded JSON array string; when omitted it targets keys as a domain. Without an explicit `from`/`to` range: latest=1m selects the one-month overview mode with pageSize 5 and isWindow=false unless explicitly provided. Use sourceType=organic or paid with IncludeNoneBranded=true and IncludeBranded=false for non-branded keyword views.

| Query field | Required | Type and constraints |
| --- | --- | --- |
| `keys` | Yes | string; 1-2048 UTF-8 bytes after trimming |
| `country` | No | nonnegative integer string; Only worldwide data is supported (`country=999`). Other valid country values are changed to `999` before the upstream request and return worldwide, not country-specific, data. |
| `from` | No | string; valid date using the formats above |
| `to` | No | string; valid date using the formats above |
| `includeSubDomains` | No | boolean string: true or false |
| `isWindow` | No | boolean string: true or false |
| `webSource` | No | string; enum: Total, Desktop, MobileWeb |
| `timeGranularity` | No | string; enum: Daily, Monthly |
| `latest` | No | string; 1-2048 UTF-8 bytes after trimming |
| `sort` | No | string; 1-2048 UTF-8 bytes after trimming |
| `asc` | No | boolean string: true or false |
| `iso` | No | string; 1-2048 UTF-8 bytes after trimming |
| `isDaily` | No | boolean string: true or false |
| `IncludeBranded` | No | boolean string: true or false |
| `IncludeNoneBranded` | No | boolean string: true or false |
| `page` | No | integer string; 1-1000 |
| `pageSize` | No | integer string; 1-1000 |
| `sourceType` | No | string; 1-2048 UTF-8 bytes after trimming |
| `pageFilterJson` | No | string containing a JSON array |

### Keyword ranking websites

`GET https://api.apihop.ai/v1/similarweb/keywords/websites`

keys is a keyword, not a website domain. Defaults include selectedPageTab=Organic, sourceType=organic, Device=Total, and graphDuration=28d. Optional page and pageSize use 1-based/positive integers.

| Query field | Required | Type and constraints |
| --- | --- | --- |
| `keys` | Yes | string; 1-2048 UTF-8 bytes after trimming |
| `country` | No | nonnegative integer string; Only worldwide data is supported (`country=999`). Other valid country values are changed to `999` before the upstream request and return worldwide, not country-specific, data. |
| `from` | No | string; valid date using the formats above |
| `to` | No | string; valid date using the formats above |
| `includeSubDomains` | No | boolean string: true or false |
| `isWindow` | No | boolean string: true or false |
| `webSource` | No | string; enum: Total, Desktop, MobileWeb |
| `timeGranularity` | No | string; enum: Daily, Monthly |
| `latest` | No | string; 1-2048 UTF-8 bytes after trimming |
| `sort` | No | string; 1-2048 UTF-8 bytes after trimming |
| `asc` | No | boolean string: true or false |
| `iso` | No | string; 1-2048 UTF-8 bytes after trimming |
| `isDaily` | No | boolean string: true or false |
| `tab` | No | nonnegative integer string |
| `mtd` | No | boolean string: true or false |
| `selectedPageTab` | No | string; enum: Organic, Paid |
| `graphDuration` | No | string; 1-2048 UTF-8 bytes after trimming |
| `graphType` | No | integer string; 1-1000 |
| `isDurationChanged` | No | boolean string: true or false |
| `ignoreFilterConsistency` | No | boolean string: true or false |
| `Device` | No | string; 1-2048 UTF-8 bytes after trimming |
| `sourceType` | No | string; 1-2048 UTF-8 bytes after trimming |
| `page` | No | integer string; 1-1000 |
| `pageSize` | No | integer string; 1-1000 |

### Traffic sources

`GET https://api.apihop.ai/v1/similarweb/websites/traffic-sources`

Defaults: sourceType=Referral, page=1, orderBy=Share desc, and timeGranularity=Daily. This table is distinct from the incoming-referrals endpoint.

### Outgoing traffic

`GET https://api.apihop.ai/v1/similarweb/websites/outgoing-traffic`

from and to are required. Singular key only. Defaults: country=999, isWWW=false, isWindow=false, webSource=Total, page=1, orderby=Share desc, orderBy=Share desc, sort=Share, asc=false. orderby and orderBy are distinct and forwarded independently; keep them consistent. No latest, pageSize, rowsPerPage, includeSubDomains, or timeGranularity. Rows are in Records; TotalCount is the upstream total, not the current page length. Only worldwide data is supported (`country=999`).

| Query field | Required | Type and constraints |
| --- | --- | --- |
| `key` | Yes | string; 1-2048 UTF-8 bytes after trimming |
| `country` | No | nonnegative integer string; Only worldwide data is supported (`country=999`). Other valid country values are changed to `999` before the upstream request and return worldwide, not country-specific, data. |
| `from` | Yes | string; valid date using the formats above |
| `to` | Yes | string; valid date using the formats above |
| `isWWW` | No | boolean string: true or false |
| `isWindow` | No | boolean string: true or false |
| `webSource` | No | string; enum: Total, Desktop, MobileWeb |
| `orderby` | No | string; 1-2048 UTF-8 bytes after trimming |
| `orderBy` | No | string; 1-2048 UTF-8 bytes after trimming |
| `sort` | No | string; 1-2048 UTF-8 bytes after trimming |
| `asc` | No | boolean string: true or false |
| `page` | No | integer string; 1-1000 |

### Incoming referrals

`GET https://api.apihop.ai/v1/similarweb/websites/incoming-referrals`

Singular key only. Defaults: country=999, latest=28d, isWWW=false, isWindow=true, isDaily=false, webSource=Total, selectedTab=incomingTraffic, orderBy=TotalShare desc, ignoreFilterConsistency=false, page=1. No keys, pageSize, rowsPerPage, includeSubDomains, or timeGranularity. Rows are in Records; native fields may include SiteOrigins and TotalShare. Only worldwide data is supported (`country=999`).

| Query field | Required | Type and constraints |
| --- | --- | --- |
| `key` | Yes | string; 1-2048 UTF-8 bytes after trimming |
| `country` | No | nonnegative integer string; Only worldwide data is supported (`country=999`). Other valid country values are changed to `999` before the upstream request and return worldwide, not country-specific, data. |
| `from` | No | string; valid date using the formats above |
| `to` | No | string; valid date using the formats above |
| `isWWW` | No | boolean string: true or false |
| `iso` | No | string; 1-2048 UTF-8 bytes after trimming |
| `isWindow` | No | boolean string: true or false |
| `isDaily` | No | boolean string: true or false |
| `latest` | No | string; 1-2048 UTF-8 bytes after trimming |
| `webSource` | No | string; enum: Total, Desktop, MobileWeb |
| `selectedTab` | No | string; enum: incomingTraffic |
| `orderBy` | No | string; 1-2048 UTF-8 bytes after trimming |
| `ignoreFilterConsistency` | No | boolean string: true or false |
| `page` | No | integer string; 1-1000 |

### Branded keyword share

`GET https://api.apihop.ai/v1/similarweb/websites/branded-keywords`

Defaults to the previous complete UTC month. duration is fixed to 1m.

### Traffic geography

`GET https://api.apihop.ai/v1/similarweb/websites/geography`

Defaults to the previous three complete UTC months, pageSize=5 and orderBy=TotalShare desc.

### Device distribution

`GET https://api.apihop.ai/v1/similarweb/websites/devices`

Defaults to the previous three complete UTC months and ShouldGetVerifiedData=false.

### Search performance

`GET https://api.apihop.ai/v1/similarweb/websites/search-performance`

Defaults to the previous complete UTC month, pageSize=5, duration=1m and SourceType=Organic. Use SourceType=Paid for paid keywords; do not substitute sourceType.

### Social traffic

`GET https://api.apihop.ai/v1/similarweb/websites/social-traffic`

Defaults to the previous three complete UTC months. webSource is not accepted.

### Engagement overview

`GET https://api.apihop.ai/v1/similarweb/websites/engagement`

Defaults include ShouldGetVerifiedData=false, includeLeaders=true and unBounced=false. Native Data rows may contain AvgMonthVisits, BounceRate, PagesPerVisit and AvgVisitDuration.

### Total visits

`GET https://api.apihop.ai/v1/similarweb/websites/visits`

compareFrom and compareTo must be supplied together as valid ordered dates. timeGranularity is Monthly. Native fields may include TotalVisits, Change and ShareOfVisits; a rolling total is not necessarily a complete-calendar-month total.

### Visits table

`GET https://api.apihop.ai/v1/similarweb/websites/visits/table`

compareFrom and compareTo must be supplied together as valid ordered dates. timeGranularity is Monthly; rows are in `Data`, with `Domain` and `TotalVisits`. `TotalCount` can be 0 even when `Data` contains rows; inspect the array itself to determine whether results are present.

### Visits trend

`GET https://api.apihop.ai/v1/similarweb/websites/visits/trend`

Defaults to the rolling 28-day daily window. timeGranularity accepts Daily, Weekly or Monthly.

### Website ranks

`GET https://api.apihop.ai/v1/similarweb/websites/ranks`

timeGranularity is Monthly. Native response uses distinct GlobalRank, CountryRank and CategoryRank objects.

### Country ranks

`GET https://api.apihop.ai/v1/similarweb/websites/ranks/country`

timeGranularity is Monthly. This is the explicit country-rank table, not the combined ranks response. Rows are in `Data`, with `Domain` and `Rank`. `TotalCount` can be 0 even when rows are present; inspect `Data` directly.

### Global ranks

`GET https://api.apihop.ai/v1/similarweb/websites/ranks/global`

timeGranularity is Monthly. This returns the separate global-rank table. Rows are in `Data`, with `Domain` and `Rank`. `TotalCount` can be 0 even when rows are present; inspect `Data` directly.

### Category ranks

`GET https://api.apihop.ai/v1/similarweb/websites/ranks/category`

timeGranularity is Monthly. This returns the separate industry/category-rank table. Rows are in `Data`, with `Domain` and `Rank`. `TotalCount` can be 0 even when rows are present; inspect `Data` directly.

### Traffic channels

`GET https://api.apihop.ai/v1/similarweb/websites/channels`

Defaults to the rolling 28-day daily window. With `webSource=Total`, channel values are under `Data.Total[domain]`, not directly under `Data[domain]`. Channel names are preserved, for example `Search - Organic` and `Direct`. Values are visit counts; derive shares only when their sum is positive.

### Similar sites

`GET https://api.apihop.ai/v1/similarweb/websites/similar-sites`

Defaults to the previous three complete UTC months. isWindow must be false, timeGranularity is Monthly, and orderBy is fixed to Affinity desc. No latest or webSource.

### Similar site suggestions

`GET https://api.apihop.ai/v1/similarweb/websites/similar-sites/suggestions`

Singular key; limit defaults to 20 and must be 1-20. country defaults to 999 and webSource to Total. The observed native response is an unwrapped array of candidates containing `Domain`, `DomainWithoutSub`, numeric `Rank`, and `Favicon`; do not expect a `Data` envelope. An empty array contains no suggestions. Only worldwide data is supported (`country=999`).

| Query field | Required | Type and constraints |
| --- | --- | --- |
| `key` | Yes | string; 1-2048 UTF-8 bytes after trimming |
| `limit` | No | integer string; 1-20 |
| `country` | No | nonnegative integer string; Only worldwide data is supported (`country=999`). Other valid country values are changed to `999` before the upstream request and return worldwide, not country-specific, data. |
| `webSource` | No | string; enum: Total, Desktop, MobileWeb |

### Monthly visits history

`GET https://api.apihop.ai/v1/similarweb/websites/history/visits`

Defaults to the previous six complete UTC months. Only country=999, isWindow=false and timeGranularity=Monthly are supported. latest accepts 1m through 6m; explicit dates must be complete months inside that rolling six-month window. Native series may appear under Data.<domain>.<source> with Key/Value points; source names, including MobileWeb or Mobile Web, are preserved. Values represent estimated visits.

### Monthly bounce rate history

`GET https://api.apihop.ai/v1/similarweb/websites/history/bounce-rate`

### Monthly visit duration history

`GET https://api.apihop.ai/v1/similarweb/websites/history/visit-duration`

### Monthly pages per visit history

`GET https://api.apihop.ai/v1/similarweb/websites/history/pages-per-visit`

Mọi đường dẫn bên dưới tương đối với địa chỉ gốc API của bạn. Mọi yêu cầu cần Authorization: Bearer YOUR_API_KEY, dùng GET và không có thân yêu cầu. Xem xác thực, tính phí và lỗi.

Quy tắc truy vấn

Trường website số ít key và Key yêu cầu một tên miền ASCII như amazon.com, tối đa 253 ký tự, không có khoảng trắng bao quanh. Không gửi URL, địa chỉ IP, danh sách tên miền hoặc thông tin xác thực API trong các trường này. Dùng punycode cho tên miền quốc tế hóa.

Tên truy vấn phân biệt chữ hoa/chữ thường. Trường không rõ, trường trùng lặp, CR/LF/NUL và giá trị không hợp lệ bị từ chối. Giá trị boolean là giá trị nguyên văn true hoặc false; số không không thể thay thế false. Văn bản dài 1-2048 byte UTF-8 sau khi cắt khoảng trắng. Mã hóa dấu cách, mảng JSON và dấu phân cách bằng bộ mã hóa truy vấn của máy khách HTTP.

from và to phải xuất hiện cùng nhau, là ngày lịch thực theo định dạng YYYY-MM-DD hoặc YYYY|MM|DD và thỏa from <= to. Cặp so sánh theo cùng quy tắc. Trường tùy chọn kế thừa mặc định điểm cuối; bảng liệt kê trường được phép, không yêu cầu gửi tất cả.

Với điểm cuối chấp nhận ngày, khoảng from/to rõ ràng, hợp lệ và đầy đủ được ưu tiên. Ở điểm cuối chấp nhận latest, giá trị được cung cấp vẫn phải vượt xác thực định dạng hiện có và riêng của điểm cuối, nhưng bị bỏ qua khi chọn khoảng và không được gửi tới Similarweb; không thêm latest mặc định. Khi không có khoảng rõ ràng, hành vi latest, mặc định và cửa sổ hiện có giữ nguyên. Hạn chế lịch sử vẫn áp dụng, và điểm cuối không chấp nhận latest vẫn từ chối nó.

Khi không có khoảng from/to rõ ràng: Tuyến theo cửa sổ thường mặc định 28 ngày kết thúc ba ngày UTC trước và chấp nhận latest=1d đến 366d. Tuyến tháng cố định có mặc định ghi bên dưới. Tương tác, lượt truy cập, xếp hạng và kênh còn chấp nhận latest=1m|2m|3m|6m cho các tháng lịch UTC trọn vẹn trước đó; bộ chọn này yêu cầu isWindow=false và mặc định timeGranularity=Monthly. Lịch sử có quy tắc hẹp hơn được mô tả cho bốn điểm cuối của nó.

Chỉ hỗ trợ dữ liệu toàn cầu (country=999). Mã định danh website là tên miền như example.com, trừ điểm cuối xếp hạng từ khóa, nơi keys là từ khóa tìm kiếm. Khả dụng dữ liệu thượng nguồn, bộ lọc và kiểu đối sánh có thể khác nhau. Giá trị quốc gia hợp lệ khác được đổi thành 999 trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.

Phản hồi thành công giữ JSON gốc thay vì dùng lược đồ phản hồi chung. Bảng giới thiệu đến và đi dùng Records; chỉ số lịch sử có thể dùng Data lồng nhau. Tên và đơn vị bên dưới không có nghĩa mọi trường thượng nguồn tùy chọn luôn xuất hiện.

Điểm cuối

Gợi ý từ khóa

GET https://api.apihop.ai/v1/similarweb/keywords/suggestions

Mặc định: country 999, latest 28d, rowsPerPage 100, type Broad, websource Total và windowVolume giảm dần. page tùy chọn bắt đầu từ 1. rangeFilter dùng cú pháp gốc, ví dụ volume,100,10000|difficulty,0,40. Khả dụng kiểu đối sánh và bộ lọc phụ thuộc nguồn dữ liệu. Chỉ hỗ trợ dữ liệu toàn cầu (country=999).

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keyword`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`sort`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`asc`	Không	chuỗi boolean: true hoặc false
`page`	Không	chuỗi số nguyên; 1-1000
`rowsPerPage`	Không	chuỗi số nguyên; 1-1000
`type`	Không	chuỗi; giá trị: Broad, Phrase, Exact, Related
`websource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`isWindow`	Không	chuỗi boolean: true hoặc false
`rangeFilter`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng

Liên kết ngược

GET https://api.apihop.ai/v1/similarweb/websites/backlinks

Mặc định: Page 1, PageSize 100, Status All, FollowType All và DomainScore giảm dần. Key viết hoa; không dùng key hoặc keys.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`Key`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`Page`	Không	chuỗi số nguyên; 1-1000
`PageSize`	Không	chuỗi số nguyên; 1-1000
`Status`	Không	chuỗi; giá trị: All, Active, New, Lost
`FollowType`	Không	chuỗi; giá trị: All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow
`DomainScoreFrom`	Không	chuỗi số nguyên; 0-100
`DomainScoreTo`	Không	chuỗi số nguyên; 0-100
`sort`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`asc`	Không	chuỗi boolean: true hoặc false

Từ khóa website

GET https://api.apihop.ai/v1/similarweb/websites/keywords

Mặc định: page 1, pageSize 100, sourceType all và cả hai cờ thương hiệu là false. pageFilterJson là một chuỗi mảng JSON mã hóa URL; khi bỏ qua, nó nhắm keys như tên miền. Khi không có khoảng from/to rõ ràng: latest=1m chọn chế độ tổng quan một tháng với pageSize 5 và isWindow=false trừ khi cung cấp rõ ràng. Dùng sourceType=organic hoặc paid với IncludeNoneBranded=true và IncludeBranded=false để xem từ khóa không thương hiệu.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Daily, Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`sort`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`asc`	Không	chuỗi boolean: true hoặc false
`iso`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`isDaily`	Không	chuỗi boolean: true hoặc false
`IncludeBranded`	Không	chuỗi boolean: true hoặc false
`IncludeNoneBranded`	Không	chuỗi boolean: true hoặc false
`page`	Không	chuỗi số nguyên; 1-1000
`pageSize`	Không	chuỗi số nguyên; 1-1000
`sourceType`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`pageFilterJson`	Không	chuỗi chứa mảng JSON

Website xếp hạng theo từ khóa

GET https://api.apihop.ai/v1/similarweb/keywords/websites

keys là từ khóa, không phải tên miền website. Mặc định gồm selectedPageTab=Organic, sourceType=organic, Device=Total và graphDuration=28d. page và pageSize tùy chọn dùng số nguyên bắt đầu từ 1/số nguyên dương.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Daily, Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`sort`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`asc`	Không	chuỗi boolean: true hoặc false
`iso`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`isDaily`	Không	chuỗi boolean: true hoặc false
`tab`	Không	chuỗi số nguyên không âm
`mtd`	Không	chuỗi boolean: true hoặc false
`selectedPageTab`	Không	chuỗi; giá trị: Organic, Paid
`graphDuration`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`graphType`	Không	chuỗi số nguyên; 1-1000
`isDurationChanged`	Không	chuỗi boolean: true hoặc false
`ignoreFilterConsistency`	Không	chuỗi boolean: true hoặc false
`Device`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`sourceType`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`page`	Không	chuỗi số nguyên; 1-1000
`pageSize`	Không	chuỗi số nguyên; 1-1000

Nguồn lưu lượng

GET https://api.apihop.ai/v1/similarweb/websites/traffic-sources

Mặc định: sourceType=Referral, page=1, orderBy=Share desc và timeGranularity=Daily. Bảng này khác điểm cuối nguồn giới thiệu đến.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Daily, Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`sourceType`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`ignoreFilterConsistency`	Không	chuỗi boolean: true hoặc false
`page`	Không	chuỗi số nguyên; 1-1000
`orderBy`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng

Lưu lượng đi

GET https://api.apihop.ai/v1/similarweb/websites/outgoing-traffic

from và to là bắt buộc. Chỉ dùng key số ít. Mặc định: country=999, isWWW=false, isWindow=false, webSource=Total, page=1, orderby=Share desc, orderBy=Share desc, sort=Share, asc=false. orderby và orderBy là hai trường riêng, được chuyển tiếp độc lập; giữ chúng nhất quán. Không có latest, pageSize, rowsPerPage, includeSubDomains hoặc timeGranularity. Hàng nằm trong Records; TotalCount là tổng thượng nguồn, không phải độ dài trang hiện tại. Chỉ hỗ trợ dữ liệu toàn cầu (country=999).

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`key`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Có	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Có	chuỗi; ngày hợp lệ theo định dạng bên trên
`isWWW`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`orderby`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`orderBy`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`sort`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`asc`	Không	chuỗi boolean: true hoặc false
`page`	Không	chuỗi số nguyên; 1-1000

Nguồn giới thiệu đến

GET https://api.apihop.ai/v1/similarweb/websites/incoming-referrals

Chỉ dùng key số ít. Mặc định: country=999, latest=28d, isWWW=false, isWindow=true, isDaily=false, webSource=Total, selectedTab=incomingTraffic, orderBy=TotalShare desc, ignoreFilterConsistency=false, page=1. Không có keys, pageSize, rowsPerPage, includeSubDomains hoặc timeGranularity. Hàng nằm trong Records; trường gốc có thể gồm SiteOrigins và TotalShare. Chỉ hỗ trợ dữ liệu toàn cầu (country=999).

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`key`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`isWWW`	Không	chuỗi boolean: true hoặc false
`iso`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`isWindow`	Không	chuỗi boolean: true hoặc false
`isDaily`	Không	chuỗi boolean: true hoặc false
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`selectedTab`	Không	chuỗi; giá trị: incomingTraffic
`orderBy`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`ignoreFilterConsistency`	Không	chuỗi boolean: true hoặc false
`page`	Không	chuỗi số nguyên; 1-1000

GET https://api.apihop.ai/v1/similarweb/websites/branded-keywords

Mặc định là tháng UTC trọn vẹn trước đó. duration cố định ở 1m.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Daily, Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`duration`	Không	chuỗi; giá trị: 1m

Địa lý lưu lượng

GET https://api.apihop.ai/v1/similarweb/websites/geography

Mặc định là ba tháng UTC trọn vẹn trước đó, pageSize=5 và orderBy=TotalShare desc.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Daily, Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`pageSize`	Không	chuỗi số nguyên; 1-1000
`orderBy`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng

Phân bố thiết bị

GET https://api.apihop.ai/v1/similarweb/websites/devices

Mặc định là ba tháng UTC trọn vẹn trước đó và ShouldGetVerifiedData=false.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Daily, Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`ShouldGetVerifiedData`	Không	chuỗi boolean: true hoặc false

Hiệu quả tìm kiếm

GET https://api.apihop.ai/v1/similarweb/websites/search-performance

Mặc định là tháng UTC trọn vẹn trước đó, pageSize=5, duration=1m và SourceType=Organic. Dùng SourceType=Paid cho từ khóa trả phí; không thay bằng sourceType.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Daily, Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`pageSize`	Không	chuỗi số nguyên; 1-1000
`duration`	Không	chuỗi; giá trị: 1m
`SourceType`	Không	chuỗi; giá trị: Organic, Paid

GET https://api.apihop.ai/v1/similarweb/websites/social-traffic

Mặc định là ba tháng UTC trọn vẹn trước đó. Không chấp nhận webSource.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`timeGranularity`	Không	chuỗi; giá trị: Daily, Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng

Tổng quan tương tác

GET https://api.apihop.ai/v1/similarweb/websites/engagement

Mặc định gồm ShouldGetVerifiedData=false, includeLeaders=true và unBounced=false. Hàng Data gốc có thể chứa AvgMonthVisits, BounceRate, PagesPerVisit và AvgVisitDuration.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Daily, Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`ShouldGetVerifiedData`	Không	chuỗi boolean: true hoặc false
`includeLeaders`	Không	chuỗi boolean: true hoặc false
`unBounced`	Không	chuỗi boolean: true hoặc false
`beta`	Không	chuỗi boolean: true hoặc false

Tổng lượt truy cập

GET https://api.apihop.ai/v1/similarweb/websites/visits

compareFrom và compareTo phải được cung cấp cùng nhau dưới dạng ngày hợp lệ đúng thứ tự. timeGranularity là Monthly. Trường gốc có thể gồm TotalVisits, Change và ShareOfVisits; tổng cuốn chiếu không nhất thiết là tổng tháng lịch trọn vẹn.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`compareFrom`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`compareTo`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`ShouldGetVerifiedData`	Không	chuỗi boolean: true hoặc false

Bảng lượt truy cập

GET https://api.apihop.ai/v1/similarweb/websites/visits/table

compareFrom và compareTo phải được cung cấp cùng nhau dưới dạng ngày hợp lệ đúng thứ tự. timeGranularity là Monthly; hàng nằm trong Data, có Domain và TotalVisits. TotalCount có thể bằng 0 ngay cả khi Data chứa hàng; kiểm tra chính mảng để xác định có kết quả hay không.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`compareFrom`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`compareTo`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`ShouldGetVerifiedData`	Không	chuỗi boolean: true hoặc false

Xu hướng lượt truy cập

GET https://api.apihop.ai/v1/similarweb/websites/visits/trend

Mặc định là cửa sổ theo ngày cuốn chiếu 28 ngày. timeGranularity chấp nhận Daily, Weekly hoặc Monthly.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Daily, Weekly, Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`ShouldGetVerifiedData`	Không	chuỗi boolean: true hoặc false

Xếp hạng website

GET https://api.apihop.ai/v1/similarweb/websites/ranks

timeGranularity là Monthly. Phản hồi gốc dùng các đối tượng GlobalRank, CountryRank và CategoryRank riêng.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng

Xếp hạng quốc gia

GET https://api.apihop.ai/v1/similarweb/websites/ranks/country

timeGranularity là Monthly. Đây là bảng xếp hạng quốc gia riêng, không phải phản hồi xếp hạng kết hợp. Hàng nằm trong Data, có Domain và Rank. TotalCount có thể bằng 0 ngay cả khi có hàng; kiểm tra trực tiếp Data.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng

Xếp hạng toàn cầu

GET https://api.apihop.ai/v1/similarweb/websites/ranks/global

timeGranularity là Monthly. Trả bảng xếp hạng toàn cầu riêng. Hàng nằm trong Data, có Domain và Rank. TotalCount có thể bằng 0 ngay cả khi có hàng; kiểm tra trực tiếp Data.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng

Xếp hạng danh mục

GET https://api.apihop.ai/v1/similarweb/websites/ranks/category

timeGranularity là Monthly. Trả bảng xếp hạng ngành/danh mục riêng. Hàng nằm trong Data, có Domain và Rank. TotalCount có thể bằng 0 ngay cả khi có hàng; kiểm tra trực tiếp Data.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng

Kênh lưu lượng

GET https://api.apihop.ai/v1/similarweb/websites/channels

Mặc định là cửa sổ theo ngày cuốn chiếu 28 ngày. Với webSource=Total, giá trị kênh nằm dưới Data.Total[domain], không trực tiếp dưới Data[domain]. Tên kênh được giữ nguyên, ví dụ Search - Organic và Direct. Giá trị là số lượt truy cập; chỉ tính tỷ trọng khi tổng dương.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Daily, Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng

Website tương tự

GET https://api.apihop.ai/v1/similarweb/websites/similar-sites

Mặc định là ba tháng UTC trọn vẹn trước đó. isWindow phải là false, timeGranularity là Monthly và orderBy cố định ở Affinity desc. Không có latest hoặc webSource.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`timeGranularity`	Không	chuỗi; giá trị: Monthly
`orderBy`	Không	chuỗi; giá trị: Affinity desc

Gợi ý website tương tự

GET https://api.apihop.ai/v1/similarweb/websites/similar-sites/suggestions

key số ít; limit mặc định 20 và phải từ 1-20. country mặc định 999 và webSource là Total. Phản hồi gốc quan sát được là mảng ứng viên không bọc chứa Domain, DomainWithoutSub, Rank dạng số và Favicon; đừng chờ lớp bao Data. Mảng rỗng không có gợi ý. Chỉ hỗ trợ dữ liệu toàn cầu (country=999).

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`key`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`limit`	Không	chuỗi số nguyên; 1-20
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb

Lịch sử lượt truy cập theo tháng

GET https://api.apihop.ai/v1/similarweb/websites/history/visits

Mặc định là sáu tháng UTC trọn vẹn trước đó. Chỉ hỗ trợ country=999, isWindow=false và timeGranularity=Monthly. latest chấp nhận 1m đến 6m; ngày rõ ràng phải là tháng trọn vẹn trong cửa sổ cuốn chiếu sáu tháng đó. Chuỗi gốc có thể xuất hiện dưới Data.<domain>.<source> với điểm Key/Value; tên nguồn, gồm MobileWeb hoặc Mobile Web, được giữ nguyên. Giá trị biểu thị lượt truy cập ước tính.

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng

Lịch sử tỷ lệ thoát theo tháng

GET https://api.apihop.ai/v1/similarweb/websites/history/bounce-rate

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng

Lịch sử thời lượng truy cập theo tháng

GET https://api.apihop.ai/v1/similarweb/websites/history/visit-duration

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng

Lịch sử số trang mỗi lượt truy cập theo tháng

GET https://api.apihop.ai/v1/similarweb/websites/history/pages-per-visit

Trường truy vấn	Bắt buộc	Kiểu và ràng buộc
`keys`	Có	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng
`country`	Không	chuỗi số nguyên không âm; Chỉ hỗ trợ dữ liệu toàn cầu (`country=999`). Giá trị quốc gia hợp lệ khác được đổi thành `999` trước yêu cầu thượng nguồn và trả dữ liệu toàn cầu, không phải riêng quốc gia.
`from`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`to`	Không	chuỗi; ngày hợp lệ theo định dạng bên trên
`includeSubDomains`	Không	chuỗi boolean: true hoặc false
`isWindow`	Không	chuỗi boolean: true hoặc false
`webSource`	Không	chuỗi; giá trị: Total, Desktop, MobileWeb
`timeGranularity`	Không	chuỗi; giá trị: Monthly
`latest`	Không	chuỗi; 1-2048 byte UTF-8 sau khi cắt khoảng trắng