Dokumentasi API Hop
Referensi endpoint SimilarwebAPI
Seluruh 27 endpoint GET SimilarwebAPI dengan nama kueri, tipe, batas, jendela tanggal, dan perilaku respons yang tepat.
Semua jalur di bawah relatif terhadap origin API Anda. Setiap permintaan memerlukan Authorization: Bearer YOUR_API_KEY, menggunakan GET, dan tidak memiliki isi permintaan. Lihat autentikasi, penagihan, dan kesalahan.
Aturan Kueri
Kolom situs tunggal key dan Key memerlukan satu domain ASCII seperti amazon.com, maksimal 253 karakter, tanpa spasi di sekitarnya. Jangan mengirim URL, alamat IP, daftar domain, atau kredensial API dalam kolom ini. Gunakan punycode untuk domain internasional.
Nama kueri peka huruf besar-kecil. Kolom yang tidak dikenal, kolom duplikat, CR/LF/NUL, dan nilai tidak valid ditolak. Nilai boolean adalah literal true atau false; nol tidak dapat dipertukarkan dengan false. Teks berukuran 1-2048 byte UTF-8 setelah spasi tepi dihapus. Enkode spasi, larik JSON, dan pemisah dengan encoder kueri klien HTTP Anda.
from dan to harus disertakan bersama, berupa tanggal kalender nyata dalam format YYYY-MM-DD atau YYYY|MM|DD, dan memenuhi from <= to. Pasangan perbandingan mengikuti aturan yang sama. Kolom opsional mewarisi nilai bawaan endpoint; tabel mencantumkan kolom yang diizinkan, bukan kewajiban mengirim semuanya.
Untuk endpoint yang menerima tanggal, rentang from/to eksplisit yang valid dan lengkap diprioritaskan. Pada endpoint yang menerima latest, nilai yang diberikan tetap harus lolos validasi format yang ada dan validasi khusus endpoint, tetapi diabaikan untuk pemilihan rentang dan tidak dikirim ke Similarweb; tidak ada latest bawaan yang ditambahkan. Tanpa rentang eksplisit, perilaku latest, nilai bawaan, dan jendela yang ada tidak berubah. Pembatasan riwayat tetap berlaku, dan endpoint yang tidak menerima latest tetap menolaknya.
Tanpa rentang from/to eksplisit: rute berbasis jendela biasanya menggunakan bawaan 28 hari yang berakhir tiga hari UTC lalu dan menerima latest=1d hingga 366d. Rute bulan tetap memiliki nilai bawaan yang dicatat di bawah. Interaksi, kunjungan, peringkat, dan kanal juga menerima latest=1m|2m|3m|6m untuk bulan kalender UTC lengkap sebelumnya; pemilih ini memerlukan isWindow=false dan menggunakan bawaan timeGranularity=Monthly. Riwayat memiliki aturan lebih terbatas yang didokumentasikan untuk keempat endpoint-nya.
Hanya data seluruh dunia yang didukung (country=999). Pengenal situs berupa domain seperti example.com, kecuali endpoint peringkat kata kunci yang menggunakan keys sebagai kata kunci pencarian. Ketersediaan data upstream, filter, dan tipe pencocokan dapat berbeda. Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara.
Respons berhasil mempertahankan JSON native, bukan mengadopsi skema respons universal. Tabel rujukan masuk dan keluar menggunakan Records; metrik riwayat dapat menggunakan Data bertingkat. Nama dan unit yang dijelaskan di bawah tidak berarti setiap kolom upstream opsional selalu ada.
Endpoint
Saran kata kunci
GET https://api.apihop.ai/v1/similarweb/keywords/suggestions
Nilai bawaan: country 999, latest 28d, rowsPerPage 100, type Broad, websource Total, dan windowVolume menurun. page opsional berbasis 1. rangeFilter menggunakan sintaks native, misalnya volume,100,10000|difficulty,0,40. Ketersediaan tipe pencocokan dan filter bergantung pada sumber data. Hanya data seluruh dunia yang didukung (country=999).
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keyword | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
sort | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
asc | Tidak | string boolean: true atau false |
page | Tidak | string bilangan bulat; 1-1000 |
rowsPerPage | Tidak | string bilangan bulat; 1-1000 |
type | Tidak | string; enumerasi: Broad, Phrase, Exact, Related |
websource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
isWindow | Tidak | string boolean: true atau false |
rangeFilter | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
Backlink
GET https://api.apihop.ai/v1/similarweb/websites/backlinks
Nilai bawaan: Page 1, PageSize 100, Status All, FollowType All, dan DomainScore menurun. Key menggunakan huruf awal besar; jangan gunakan key atau keys.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
Key | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
Page | Tidak | string bilangan bulat; 1-1000 |
PageSize | Tidak | string bilangan bulat; 1-1000 |
Status | Tidak | string; enumerasi: All, Active, New, Lost |
FollowType | Tidak | string; enumerasi: All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow |
DomainScoreFrom | Tidak | string bilangan bulat; 0-100 |
DomainScoreTo | Tidak | string bilangan bulat; 0-100 |
sort | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
asc | Tidak | string boolean: true atau false |
Kata kunci situs
GET https://api.apihop.ai/v1/similarweb/websites/keywords
Nilai bawaan: page 1, pageSize 100, sourceType all, dan kedua flag bermerek false. pageFilterJson adalah satu string larik JSON yang dienkode URL; jika dihilangkan, targetnya adalah keys sebagai domain. Tanpa rentang from/to eksplisit: latest=1m memilih mode ringkasan satu bulan dengan pageSize 5 dan isWindow=false kecuali disediakan secara eksplisit. Gunakan sourceType=organic atau paid dengan IncludeNoneBranded=true dan IncludeBranded=false untuk tampilan kata kunci tanpa merek.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Daily, Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
sort | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
asc | Tidak | string boolean: true atau false |
iso | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
isDaily | Tidak | string boolean: true atau false |
IncludeBranded | Tidak | string boolean: true atau false |
IncludeNoneBranded | Tidak | string boolean: true atau false |
page | Tidak | string bilangan bulat; 1-1000 |
pageSize | Tidak | string bilangan bulat; 1-1000 |
sourceType | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
pageFilterJson | Tidak | string berisi larik JSON |
Situs berperingkat untuk kata kunci
GET https://api.apihop.ai/v1/similarweb/keywords/websites
keys adalah kata kunci, bukan domain situs. Nilai bawaan mencakup selectedPageTab=Organic, sourceType=organic, Device=Total, dan graphDuration=28d. page dan pageSize opsional menggunakan bilangan bulat berbasis 1/positif.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Daily, Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
sort | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
asc | Tidak | string boolean: true atau false |
iso | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
isDaily | Tidak | string boolean: true atau false |
tab | Tidak | string bilangan bulat nonnegatif |
mtd | Tidak | string boolean: true atau false |
selectedPageTab | Tidak | string; enumerasi: Organic, Paid |
graphDuration | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
graphType | Tidak | string bilangan bulat; 1-1000 |
isDurationChanged | Tidak | string boolean: true atau false |
ignoreFilterConsistency | Tidak | string boolean: true atau false |
Device | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
sourceType | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
page | Tidak | string bilangan bulat; 1-1000 |
pageSize | Tidak | string bilangan bulat; 1-1000 |
Sumber lalu lintas
GET https://api.apihop.ai/v1/similarweb/websites/traffic-sources
Nilai bawaan: sourceType=Referral, page=1, orderBy=Share desc, dan timeGranularity=Daily. Tabel ini berbeda dari endpoint rujukan masuk.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Daily, Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
sourceType | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
ignoreFilterConsistency | Tidak | string boolean: true atau false |
page | Tidak | string bilangan bulat; 1-1000 |
orderBy | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
Lalu lintas keluar
GET https://api.apihop.ai/v1/similarweb/websites/outgoing-traffic
from dan to wajib. Hanya key tunggal. Nilai bawaan: country=999, isWWW=false, isWindow=false, webSource=Total, page=1, orderby=Share desc, orderBy=Share desc, sort=Share, asc=false. orderby dan orderBy berbeda dan diteruskan secara independen; pertahankan konsistensinya. Tidak ada latest, pageSize, rowsPerPage, includeSubDomains, atau timeGranularity. Baris berada dalam Records; TotalCount adalah total upstream, bukan panjang halaman saat ini. Hanya data seluruh dunia yang didukung (country=999).
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
key | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Ya | string; tanggal valid menggunakan format di atas |
to | Ya | string; tanggal valid menggunakan format di atas |
isWWW | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
orderby | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
orderBy | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
sort | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
asc | Tidak | string boolean: true atau false |
page | Tidak | string bilangan bulat; 1-1000 |
Rujukan masuk
GET https://api.apihop.ai/v1/similarweb/websites/incoming-referrals
Hanya key tunggal. Nilai bawaan: country=999, latest=28d, isWWW=false, isWindow=true, isDaily=false, webSource=Total, selectedTab=incomingTraffic, orderBy=TotalShare desc, ignoreFilterConsistency=false, page=1. Tidak ada keys, pageSize, rowsPerPage, includeSubDomains, atau timeGranularity. Baris berada dalam Records; kolom native dapat mencakup SiteOrigins dan TotalShare. Hanya data seluruh dunia yang didukung (country=999).
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
key | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
isWWW | Tidak | string boolean: true atau false |
iso | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
isWindow | Tidak | string boolean: true atau false |
isDaily | Tidak | string boolean: true atau false |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
selectedTab | Tidak | string; enumerasi: incomingTraffic |
orderBy | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
ignoreFilterConsistency | Tidak | string boolean: true atau false |
page | Tidak | string bilangan bulat; 1-1000 |
Porsi kata kunci bermerek
GET https://api.apihop.ai/v1/similarweb/websites/branded-keywords
Bawaan adalah bulan UTC lengkap sebelumnya. duration ditetapkan ke 1m.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Daily, Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
duration | Tidak | string; enumerasi: 1m |
Geografi lalu lintas
GET https://api.apihop.ai/v1/similarweb/websites/geography
Bawaan adalah tiga bulan UTC lengkap sebelumnya, pageSize=5 dan orderBy=TotalShare desc.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Daily, Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
pageSize | Tidak | string bilangan bulat; 1-1000 |
orderBy | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
Distribusi perangkat
GET https://api.apihop.ai/v1/similarweb/websites/devices
Bawaan adalah tiga bulan UTC lengkap sebelumnya dan ShouldGetVerifiedData=false.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Daily, Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
ShouldGetVerifiedData | Tidak | string boolean: true atau false |
Kinerja pencarian
GET https://api.apihop.ai/v1/similarweb/websites/search-performance
Bawaan adalah bulan UTC lengkap sebelumnya, pageSize=5, duration=1m dan SourceType=Organic. Gunakan SourceType=Paid untuk kata kunci berbayar; jangan menggantinya dengan sourceType.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Daily, Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
pageSize | Tidak | string bilangan bulat; 1-1000 |
duration | Tidak | string; enumerasi: 1m |
SourceType | Tidak | string; enumerasi: Organic, Paid |
Lalu lintas sosial
GET https://api.apihop.ai/v1/similarweb/websites/social-traffic
Bawaan adalah tiga bulan UTC lengkap sebelumnya. webSource tidak diterima.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
timeGranularity | Tidak | string; enumerasi: Daily, Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
Ringkasan interaksi
GET https://api.apihop.ai/v1/similarweb/websites/engagement
Nilai bawaan mencakup ShouldGetVerifiedData=false, includeLeaders=true dan unBounced=false. Baris Data native dapat berisi AvgMonthVisits, BounceRate, PagesPerVisit dan AvgVisitDuration.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Daily, Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
ShouldGetVerifiedData | Tidak | string boolean: true atau false |
includeLeaders | Tidak | string boolean: true atau false |
unBounced | Tidak | string boolean: true atau false |
beta | Tidak | string boolean: true atau false |
Total kunjungan
GET https://api.apihop.ai/v1/similarweb/websites/visits
compareFrom dan compareTo harus disediakan bersama sebagai tanggal valid yang berurutan. timeGranularity adalah Monthly. Kolom native dapat mencakup TotalVisits, Change dan ShareOfVisits; total bergulir belum tentu merupakan total satu bulan kalender lengkap.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
compareFrom | Tidak | string; tanggal valid menggunakan format di atas |
compareTo | Tidak | string; tanggal valid menggunakan format di atas |
ShouldGetVerifiedData | Tidak | string boolean: true atau false |
Tabel kunjungan
GET https://api.apihop.ai/v1/similarweb/websites/visits/table
compareFrom dan compareTo harus disediakan bersama sebagai tanggal valid yang berurutan. timeGranularity adalah Monthly; baris berada dalam Data, dengan Domain dan TotalVisits. TotalCount dapat bernilai 0 meskipun Data berisi baris; periksa lariknya sendiri untuk menentukan apakah hasil tersedia.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
compareFrom | Tidak | string; tanggal valid menggunakan format di atas |
compareTo | Tidak | string; tanggal valid menggunakan format di atas |
ShouldGetVerifiedData | Tidak | string boolean: true atau false |
Tren kunjungan
GET https://api.apihop.ai/v1/similarweb/websites/visits/trend
Bawaan adalah jendela harian bergulir 28 hari. timeGranularity menerima Daily, Weekly atau Monthly.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Daily, Weekly, Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
ShouldGetVerifiedData | Tidak | string boolean: true atau false |
Peringkat situs
GET https://api.apihop.ai/v1/similarweb/websites/ranks
timeGranularity adalah Monthly. Respons native menggunakan objek GlobalRank, CountryRank dan CategoryRank yang berbeda.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
Peringkat negara
GET https://api.apihop.ai/v1/similarweb/websites/ranks/country
timeGranularity adalah Monthly. Ini adalah tabel peringkat negara tersendiri, bukan respons peringkat gabungan. Baris berada dalam Data, dengan Domain dan Rank. TotalCount dapat bernilai 0 meskipun ada baris; periksa Data secara langsung.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
Peringkat global
GET https://api.apihop.ai/v1/similarweb/websites/ranks/global
timeGranularity adalah Monthly. Ini mengembalikan tabel peringkat global terpisah. Baris berada dalam Data, dengan Domain dan Rank. TotalCount dapat bernilai 0 meskipun ada baris; periksa Data secara langsung.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
Peringkat kategori
GET https://api.apihop.ai/v1/similarweb/websites/ranks/category
timeGranularity adalah Monthly. Ini mengembalikan tabel peringkat industri/kategori terpisah. Baris berada dalam Data, dengan Domain dan Rank. TotalCount dapat bernilai 0 meskipun ada baris; periksa Data secara langsung.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
Kanal lalu lintas
GET https://api.apihop.ai/v1/similarweb/websites/channels
Bawaan adalah jendela harian bergulir 28 hari. Dengan webSource=Total, nilai kanal berada di bawah Data.Total[domain], bukan langsung di bawah Data[domain]. Nama kanal dipertahankan, misalnya Search - Organic dan Direct. Nilai berupa jumlah kunjungan; hitung porsinya hanya jika jumlah total positif.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Daily, Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
Situs serupa
GET https://api.apihop.ai/v1/similarweb/websites/similar-sites
Bawaan adalah tiga bulan UTC lengkap sebelumnya. isWindow harus false, timeGranularity adalah Monthly, dan orderBy ditetapkan ke Affinity desc. Tidak ada latest atau webSource.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
timeGranularity | Tidak | string; enumerasi: Monthly |
orderBy | Tidak | string; enumerasi: Affinity desc |
Saran situs serupa
GET https://api.apihop.ai/v1/similarweb/websites/similar-sites/suggestions
key tunggal; limit bawaan 20 dan harus 1-20. country bawaan 999 dan webSource bawaan Total. Respons native yang diamati adalah larik kandidat tanpa pembungkus yang berisi Domain, DomainWithoutSub, Rank numerik, dan Favicon; jangan mengharapkan envelope Data. Larik kosong tidak berisi saran. Hanya data seluruh dunia yang didukung (country=999).
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
key | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
limit | Tidak | string bilangan bulat; 1-20 |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
Riwayat kunjungan bulanan
GET https://api.apihop.ai/v1/similarweb/websites/history/visits
Bawaan adalah enam bulan UTC lengkap sebelumnya. Hanya country=999, isWindow=false dan timeGranularity=Monthly yang didukung. latest menerima 1m hingga 6m; tanggal eksplisit harus berupa bulan lengkap dalam jendela enam bulan bergulir tersebut. Rangkaian native dapat muncul di bawah Data.<domain>.<source> dengan titik Key/Value; nama sumber, termasuk MobileWeb atau Mobile Web, dipertahankan. Nilai mewakili perkiraan kunjungan.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
Riwayat rasio pentalan bulanan
GET https://api.apihop.ai/v1/similarweb/websites/history/bounce-rate
Bawaan adalah enam bulan UTC lengkap sebelumnya. Hanya country=999, isWindow=false dan timeGranularity=Monthly yang didukung. latest menerima 1m hingga 6m; tanggal eksplisit harus berupa bulan lengkap dalam jendela enam bulan bergulir tersebut. Rangkaian native dapat muncul di bawah Data.<domain>.<source> dengan titik Key/Value; nama sumber, termasuk MobileWeb atau Mobile Web, dipertahankan. Nilai mewakili fraksi rasio pentalan.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
Riwayat durasi kunjungan bulanan
GET https://api.apihop.ai/v1/similarweb/websites/history/visit-duration
Bawaan adalah enam bulan UTC lengkap sebelumnya. Hanya country=999, isWindow=false dan timeGranularity=Monthly yang didukung. latest menerima 1m hingga 6m; tanggal eksplisit harus berupa bulan lengkap dalam jendela enam bulan bergulir tersebut. Rangkaian native dapat muncul di bawah Data.<domain>.<source> dengan titik Key/Value; nama sumber, termasuk MobileWeb atau Mobile Web, dipertahankan. Nilai mewakili detik per kunjungan.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
Riwayat halaman per kunjungan bulanan
GET https://api.apihop.ai/v1/similarweb/websites/history/pages-per-visit
Bawaan adalah enam bulan UTC lengkap sebelumnya. Hanya country=999, isWindow=false dan timeGranularity=Monthly yang didukung. latest menerima 1m hingga 6m; tanggal eksplisit harus berupa bulan lengkap dalam jendela enam bulan bergulir tersebut. Rangkaian native dapat muncul di bawah Data.<domain>.<source> dengan titik Key/Value; nama sumber, termasuk MobileWeb atau Mobile Web, dipertahankan. Nilai mewakili halaman per kunjungan.
| Kolom kueri | Wajib | Tipe dan batasan |
|---|---|---|
keys | Ya | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |
country | Tidak | string bilangan bulat nonnegatif; Hanya data seluruh dunia yang didukung (country=999). Nilai negara valid lainnya diubah menjadi 999 sebelum permintaan upstream dan mengembalikan data seluruh dunia, bukan data khusus negara. |
from | Tidak | string; tanggal valid menggunakan format di atas |
to | Tidak | string; tanggal valid menggunakan format di atas |
includeSubDomains | Tidak | string boolean: true atau false |
isWindow | Tidak | string boolean: true atau false |
webSource | Tidak | string; enumerasi: Total, Desktop, MobileWeb |
timeGranularity | Tidak | string; enumerasi: Monthly |
latest | Tidak | string; 1-2048 byte UTF-8 setelah spasi tepi dihapus |