เอกสารอ้างอิงเอนด์พอยต์ SimilarwebAPI | เอกสาร 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`

เส้นทางทั้งหมดด้านล่างอ้างอิงจากต้นทาง 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 เข้ารหัสช่องว่าง อาร์เรย์ JSON และตัวคั่นด้วยตัวเข้ารหัสคิวรีของไคลเอนต์ HTTP

from และ to ต้องมาด้วยกัน เป็นวันที่ปฏิทินจริงรูปแบบ YYYY-MM-DD หรือ YYYY|MM|DD และเป็นไปตาม from <= to คู่เปรียบเทียบใช้กฎเดียวกัน ฟิลด์เสริมใช้ค่าเริ่มต้นเอนด์พอยต์ ตารางแสดงฟิลด์ที่อนุญาต ไม่ได้บังคับส่งทั้งหมด

สำหรับเอนด์พอยต์ที่รับวันที่ ช่วง from/to ชัดเจนที่ครบและถูกต้องมีผลก่อน สำหรับเอนด์พอยต์ที่รับ latest ค่าที่ส่งยังต้องผ่านการตรวจรูปแบบเดิมและกฎเฉพาะเอนด์พอยต์ แต่จะไม่นำมาเลือกช่วงและไม่ส่งไป Similarweb โดยไม่เพิ่ม latest เริ่มต้น หากไม่มีช่วงชัดเจน พฤติกรรม latest ค่าเริ่มต้น และช่วงเดิมไม่เปลี่ยน ข้อจำกัดประวัติยังมีผล และเอนด์พอยต์ที่ไม่รับ latest ยังปฏิเสธฟิลด์นี้

เมื่อไม่มีช่วง from/to ชัดเจน: เส้นทางแบบช่วงปกติเริ่มต้นที่ 28 วัน สิ้นสุดสามวัน UTC ก่อนหน้า และรับ 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`	ไม่	สตริง enum: Broad, Phrase, Exact, Related
`websource`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: All, Active, New, Lost
`FollowType`	ไม่	สตริง enum: 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 เป็นสตริงอาร์เรย์ JSON ที่เข้ารหัส URL หนึ่งค่า เมื่อละจะใช้ 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: 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 และ pageSize เสริมใช้จำนวนเต็มเริ่มที่ 1/บวก

ฟิลด์คิวรี	จำเป็น	ชนิดและข้อจำกัด
`keys`	ใช่	สตริง 1-2048 ไบต์ UTF-8 หลังตัดช่องว่าง
`country`	ไม่	สตริงจำนวนเต็มไม่ติดลบ รองรับเฉพาะข้อมูลทั่วโลก (`country=999`) ค่าประเทศอื่นที่ถูกต้องเปลี่ยนเป็น `999` ก่อนคำขอต้นทางและส่งข้อมูลทั่วโลก ไม่ใช่เฉพาะประเทศ
`from`	ไม่	สตริง วันที่ถูกต้องตามรูปแบบข้างต้น
`to`	ไม่	สตริง วันที่ถูกต้องตามรูปแบบข้างต้น
`includeSubDomains`	ไม่	สตริงบูลีน: true หรือ false
`isWindow`	ไม่	สตริงบูลีน: true หรือ false
`webSource`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: 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 ตารางนี้แยกจากเอนด์พอยต์ incoming-referrals

ฟิลด์คิวรี	จำเป็น	ชนิดและข้อจำกัด
`keys`	ใช่	สตริง 1-2048 ไบต์ UTF-8 หลังตัดช่องว่าง
`country`	ไม่	สตริงจำนวนเต็มไม่ติดลบ รองรับเฉพาะข้อมูลทั่วโลก (`country=999`) ค่าประเทศอื่นที่ถูกต้องเปลี่ยนเป็น `999` ก่อนคำขอต้นทางและส่งข้อมูลทั่วโลก ไม่ใช่เฉพาะประเทศ
`from`	ไม่	สตริง วันที่ถูกต้องตามรูปแบบข้างต้น
`to`	ไม่	สตริง วันที่ถูกต้องตามรูปแบบข้างต้น
`includeSubDomains`	ไม่	สตริงบูลีน: true หรือ false
`isWindow`	ไม่	สตริงบูลีน: true หรือ false
`webSource`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`selectedTab`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: Daily, Monthly
`latest`	ไม่	สตริง 1-2048 ไบต์ UTF-8 หลังตัดช่องว่าง
`duration`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: Daily, Monthly
`latest`	ไม่	สตริง 1-2048 ไบต์ UTF-8 หลังตัดช่องว่าง
`pageSize`	ไม่	สตริงจำนวนเต็ม 1-1000
`duration`	ไม่	สตริง enum: 1m
`SourceType`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: 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 โดย TotalCount อาจเป็น 0 แม้ Data มีแถว ตรวจอาร์เรย์เองเพื่อดูว่ามีผลหรือไม่

ฟิลด์คิวรี	จำเป็น	ชนิดและข้อจำกัด
`keys`	ใช่	สตริง 1-2048 ไบต์ UTF-8 หลังตัดช่องว่าง
`country`	ไม่	สตริงจำนวนเต็มไม่ติดลบ รองรับเฉพาะข้อมูลทั่วโลก (`country=999`) ค่าประเทศอื่นที่ถูกต้องเปลี่ยนเป็น `999` ก่อนคำขอต้นทางและส่งข้อมูลทั่วโลก ไม่ใช่เฉพาะประเทศ
`from`	ไม่	สตริง วันที่ถูกต้องตามรูปแบบข้างต้น
`to`	ไม่	สตริง วันที่ถูกต้องตามรูปแบบข้างต้น
`includeSubDomains`	ไม่	สตริงบูลีน: true หรือ false
`isWindow`	ไม่	สตริงบูลีน: true หรือ false
`webSource`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Monthly
`orderBy`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: 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`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: Monthly
`latest`	ไม่	สตริง 1-2048 ไบต์ UTF-8 หลังตัดช่องว่าง

ประวัติหน้าต่อการเข้าชมรายเดือน

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

ฟิลด์คิวรี	จำเป็น	ชนิดและข้อจำกัด
`keys`	ใช่	สตริง 1-2048 ไบต์ UTF-8 หลังตัดช่องว่าง
`country`	ไม่	สตริงจำนวนเต็มไม่ติดลบ รองรับเฉพาะข้อมูลทั่วโลก (`country=999`) ค่าประเทศอื่นที่ถูกต้องเปลี่ยนเป็น `999` ก่อนคำขอต้นทางและส่งข้อมูลทั่วโลก ไม่ใช่เฉพาะประเทศ
`from`	ไม่	สตริง วันที่ถูกต้องตามรูปแบบข้างต้น
`to`	ไม่	สตริง วันที่ถูกต้องตามรูปแบบข้างต้น
`includeSubDomains`	ไม่	สตริงบูลีน: true หรือ false
`isWindow`	ไม่	สตริงบูลีน: true หรือ false
`webSource`	ไม่	สตริง enum: Total, Desktop, MobileWeb
`timeGranularity`	ไม่	สตริง enum: Monthly
`latest`	ไม่	สตริง 1-2048 ไบต์ UTF-8 หลังตัดช่องว่าง