API Hop Belgeleri
Similarweb API başvurusu
Similarweb uç noktalarının sorgu parametreleri, varsayılanları ve yerel yanıt biçimleri.
Aşağıdaki tüm yollar API kökünüze göredir. Her istek Authorization: Bearer YOUR_API_KEY gerektirir, GET kullanır ve istek gövdesi içermez. Kimlik doğrulama, faturalandırma ve hatalar bölümüne bakın.
Sorgu kuralları
Tekil web sitesi alanları key ve Key, amazon.com gibi en fazla 253 karakterli, başında veya sonunda boşluk bulunmayan tek bir ASCII alan adı gerektirir. Bu alanlarda URL, IP adresi, alan adı listesi veya API kimlik bilgisi göndermeyin. Uluslararası alan adları için punycode kullanın.
Sorgu adları büyük/küçük harfe duyarlıdır. Bilinmeyen alanlar, yinelenen alanlar, CR/LF/NUL ve geçersiz değerler reddedilir. Boolean değerleri doğrudan true veya false olmalıdır; sıfır, false yerine kullanılamaz. Metin, kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt uzunluğundadır. Boşlukları, JSON dizilerini ve ayırıcıları HTTP istemcinizin sorgu kodlayıcısıyla kodlayın.
from ve to birlikte bulunmalı, YYYY-MM-DD veya YYYY|MM|DD biçiminde gerçek takvim tarihleri olmalı ve from <= to koşulunu sağlamalıdır. Karşılaştırma çifti de aynı kurala uyar. İsteğe bağlı alanlar uç noktanın varsayılanlarını devralır; tablolar tüm alanların gönderilmesini değil, izin verilen alanları belirtir.
Tarih kabul eden uç noktalarda geçerli ve eksiksiz açık bir from/to aralığı önceliklidir. Uç nokta latest kabul ediyorsa gönderilen değer mevcut biçim ve uç noktaya özgü doğrulamalardan yine geçmelidir; ancak aralık seçiminde yok sayılır ve Similarweb'e gönderilmez, varsayılan latest de eklenmez. Açık bir aralık yoksa mevcut latest, varsayılan değer ve pencere davranışı değişmez. History kısıtlamaları geçerliliğini korur; latest kabul etmeyen uç noktalar bu alanı reddetmeye devam eder.
Açık bir from/to aralığı yoksa: Pencere tabanlı yollar normalde üç UTC gün önce biten 28 günlük bir pencere kullanır ve latest=1d ile 366d arasını kabul eder. Sabit aylı yollar aşağıda belirtilen varsayılanlara sahiptir. Etkileşim, ziyaret, sıralama ve kanal uç noktaları önceki tam UTC takvim ayları için ayrıca latest=1m|2m|3m|6m kabul eder; bu seçiciler isWindow=false gerektirir ve varsayılan olarak timeGranularity=Monthly kullanır. Geçmiş verileri, dört uç noktası için belgelenen daha dar kurallara tabidir.
Yalnızca dünya geneli veriler desteklenir (country=999). keys alanının arama anahtar kelimesi olduğu anahtar kelime sıralama uç noktası dışında, web sitesi tanımlayıcıları example.com gibi alan adlarıdır. Üst kaynakta veri bulunabilirliği, filtreler ve eşleme türleri değişebilir. Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür.
Başarılı yanıtlar evrensel bir yanıt şeması benimsemek yerine yerel JSON yapısını korur. Gelen ve giden yönlendirme tabloları Records kullanır; geçmiş metrikler iç içe Data kullanabilir. Aşağıda açıklanan adlar ve birimler, üst kaynağın isteğe bağlı her alanının her zaman mevcut olduğu anlamına gelmez.
Uç noktalar
Anahtar kelime önerileri
GET https://api.apihop.ai/v1/similarweb/keywords/suggestions
Varsayılanlar: country 999, latest 28d, rowsPerPage 100, type Broad, websource Total ve azalan windowVolume. İsteğe bağlı page 1'den başlar. rangeFilter yerel sözdizimini kullanır; örneğin volume,100,10000|difficulty,0,40. Eşleme türlerinin ve filtrelerin kullanılabilirliği veri kaynağına bağlıdır. Yalnızca dünya geneli veriler desteklenir (country=999).
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keyword | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
sort | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
asc | Hayır | Boolean dizesi: true veya false |
page | Hayır | Tam sayı dizesi; 1-1000 |
rowsPerPage | Hayır | Tam sayı dizesi; 1-1000 |
type | Hayır | Dize; izin verilenler: Broad, Phrase, Exact, Related |
websource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
isWindow | Hayır | Boolean dizesi: true veya false |
rangeFilter | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
Geri bağlantılar
GET https://api.apihop.ai/v1/similarweb/websites/backlinks
Varsayılanlar: Page 1, PageSize 100, Status All, FollowType All ve azalan DomainScore. Key büyük harfle başlar; key veya keys kullanmayın.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
Key | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
Page | Hayır | Tam sayı dizesi; 1-1000 |
PageSize | Hayır | Tam sayı dizesi; 1-1000 |
Status | Hayır | Dize; izin verilenler: All, Active, New, Lost |
FollowType | Hayır | Dize; izin verilenler: All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow |
DomainScoreFrom | Hayır | Tam sayı dizesi; 0-100 |
DomainScoreTo | Hayır | Tam sayı dizesi; 0-100 |
sort | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
asc | Hayır | Boolean dizesi: true veya false |
Web sitesi anahtar kelimeleri
GET https://api.apihop.ai/v1/similarweb/websites/keywords
Varsayılanlar: page 1, pageSize 100, sourceType all ve her iki marka bayrağı false. pageFilterJson, URL kodlamalı tek bir JSON dizisi dizesidir; belirtilmezse keys bir alan adı olarak hedeflenir. Açık bir from/to aralığı yoksa: latest=1m, açıkça belirtilmedikçe pageSize 5 ve isWindow=false ile bir aylık genel bakış modunu seçer. Marka içermeyen anahtar kelime görünümleri için sourceType=organic veya paid ile IncludeNoneBranded=true ve IncludeBranded=false kullanın.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Daily, Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
sort | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
asc | Hayır | Boolean dizesi: true veya false |
iso | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
isDaily | Hayır | Boolean dizesi: true veya false |
IncludeBranded | Hayır | Boolean dizesi: true veya false |
IncludeNoneBranded | Hayır | Boolean dizesi: true veya false |
page | Hayır | Tam sayı dizesi; 1-1000 |
pageSize | Hayır | Tam sayı dizesi; 1-1000 |
sourceType | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
pageFilterJson | Hayır | JSON dizisi içeren dize |
Anahtar kelimede sıralanan web siteleri
GET https://api.apihop.ai/v1/similarweb/keywords/websites
keys bir anahtar kelimedir, web sitesi alan adı değildir. Varsayılanlar selectedPageTab=Organic, sourceType=organic, Device=Total ve graphDuration=28d içerir. İsteğe bağlı page 1'den başlar; pageSize pozitif tam sayı kullanır.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Daily, Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
sort | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
asc | Hayır | Boolean dizesi: true veya false |
iso | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
isDaily | Hayır | Boolean dizesi: true veya false |
tab | Hayır | Negatif olmayan tam sayı dizesi |
mtd | Hayır | Boolean dizesi: true veya false |
selectedPageTab | Hayır | Dize; izin verilenler: Organic, Paid |
graphDuration | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
graphType | Hayır | Tam sayı dizesi; 1-1000 |
isDurationChanged | Hayır | Boolean dizesi: true veya false |
ignoreFilterConsistency | Hayır | Boolean dizesi: true veya false |
Device | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
sourceType | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
page | Hayır | Tam sayı dizesi; 1-1000 |
pageSize | Hayır | Tam sayı dizesi; 1-1000 |
Trafik kaynakları
GET https://api.apihop.ai/v1/similarweb/websites/traffic-sources
Varsayılanlar: sourceType=Referral, page=1, orderBy=Share desc ve timeGranularity=Daily. Bu tablo gelen yönlendirmeler uç noktasından ayrıdır.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Daily, Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
sourceType | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
ignoreFilterConsistency | Hayır | Boolean dizesi: true veya false |
page | Hayır | Tam sayı dizesi; 1-1000 |
orderBy | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
Giden trafik
GET https://api.apihop.ai/v1/similarweb/websites/outgoing-traffic
from ve to zorunludur. Yalnızca tekil key kullanılır. Varsayılanlar: country=999, isWWW=false, isWindow=false, webSource=Total, page=1, orderby=Share desc, orderBy=Share desc, sort=Share, asc=false. orderby ve orderBy ayrı alanlardır ve bağımsız iletilir; tutarlı tutun. latest, pageSize, rowsPerPage, includeSubDomains veya timeGranularity kabul edilmez. Satırlar Records içindedir; TotalCount mevcut sayfa uzunluğu değil, üst kaynağın toplamıdır. Yalnızca dünya geneli veriler desteklenir (country=999).
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
key | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Evet | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Evet | Dize; yukarıdaki biçimlerde geçerli tarih |
isWWW | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
orderby | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
orderBy | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
sort | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
asc | Hayır | Boolean dizesi: true veya false |
page | Hayır | Tam sayı dizesi; 1-1000 |
Gelen yönlendirmeler
GET https://api.apihop.ai/v1/similarweb/websites/incoming-referrals
Yalnızca tekil key kullanılır. Varsayılanlar: 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 veya timeGranularity kabul edilmez. Satırlar Records içindedir; yerel alanlar SiteOrigins ve TotalShare içerebilir. Yalnızca dünya geneli veriler desteklenir (country=999).
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
key | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
isWWW | Hayır | Boolean dizesi: true veya false |
iso | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
isWindow | Hayır | Boolean dizesi: true veya false |
isDaily | Hayır | Boolean dizesi: true veya false |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
selectedTab | Hayır | Dize; izin verilenler: incomingTraffic |
orderBy | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
ignoreFilterConsistency | Hayır | Boolean dizesi: true veya false |
page | Hayır | Tam sayı dizesi; 1-1000 |
Markalı anahtar kelime payı
GET https://api.apihop.ai/v1/similarweb/websites/branded-keywords
Varsayılan önceki tam UTC ayıdır. duration, 1m olarak sabittir.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Daily, Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
duration | Hayır | Dize; izin verilenler: 1m |
Trafiğin coğrafi dağılımı
GET https://api.apihop.ai/v1/similarweb/websites/geography
Varsayılanlar önceki üç tam UTC ayı, pageSize=5 ve orderBy=TotalShare desc değerleridir.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Daily, Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
pageSize | Hayır | Tam sayı dizesi; 1-1000 |
orderBy | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
Cihaz dağılımı
GET https://api.apihop.ai/v1/similarweb/websites/devices
Varsayılanlar önceki üç tam UTC ayı ve ShouldGetVerifiedData=false değeridir.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Daily, Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
ShouldGetVerifiedData | Hayır | Boolean dizesi: true veya false |
Arama performansı
GET https://api.apihop.ai/v1/similarweb/websites/search-performance
Varsayılanlar önceki tam UTC ayı, pageSize=5, duration=1m ve SourceType=Organic değerleridir. Ücretli anahtar kelimeler için SourceType=Paid kullanın; sourceType ile değiştirmeyin.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Daily, Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
pageSize | Hayır | Tam sayı dizesi; 1-1000 |
duration | Hayır | Dize; izin verilenler: 1m |
SourceType | Hayır | Dize; izin verilenler: Organic, Paid |
Sosyal trafik
GET https://api.apihop.ai/v1/similarweb/websites/social-traffic
Varsayılan önceki üç tam UTC ayıdır. webSource kabul edilmez.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
timeGranularity | Hayır | Dize; izin verilenler: Daily, Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
Etkileşime genel bakış
GET https://api.apihop.ai/v1/similarweb/websites/engagement
Varsayılanlar ShouldGetVerifiedData=false, includeLeaders=true ve unBounced=false içerir. Yerel Data satırları AvgMonthVisits, BounceRate, PagesPerVisit ve AvgVisitDuration içerebilir.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Daily, Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
ShouldGetVerifiedData | Hayır | Boolean dizesi: true veya false |
includeLeaders | Hayır | Boolean dizesi: true veya false |
unBounced | Hayır | Boolean dizesi: true veya false |
beta | Hayır | Boolean dizesi: true veya false |
Toplam ziyaretler
GET https://api.apihop.ai/v1/similarweb/websites/visits
compareFrom ve compareTo, geçerli ve sıralı tarihler olarak birlikte verilmelidir. timeGranularity, Monthly değerindedir. Yerel alanlar TotalVisits, Change ve ShareOfVisits içerebilir; kayan toplam mutlaka tam takvim ayı toplamı değildir.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
compareFrom | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
compareTo | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
ShouldGetVerifiedData | Hayır | Boolean dizesi: true veya false |
Ziyaret tablosu
GET https://api.apihop.ai/v1/similarweb/websites/visits/table
compareFrom ve compareTo, geçerli ve sıralı tarihler olarak birlikte verilmelidir. timeGranularity, Monthly değerindedir; satırlar Domain ve TotalVisits ile Data içindedir. Data satır içerse bile TotalCount 0 olabilir; sonuç bulunup bulunmadığını belirlemek için dizinin kendisini inceleyin.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
compareFrom | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
compareTo | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
ShouldGetVerifiedData | Hayır | Boolean dizesi: true veya false |
Ziyaret eğilimi
GET https://api.apihop.ai/v1/similarweb/websites/visits/trend
Varsayılan, kayan 28 günlük günlük penceredir. timeGranularity, Daily, Weekly veya Monthly kabul eder.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Daily, Weekly, Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
ShouldGetVerifiedData | Hayır | Boolean dizesi: true veya false |
Web sitesi sıralamaları
GET https://api.apihop.ai/v1/similarweb/websites/ranks
timeGranularity, Monthly değerindedir. Yerel yanıt ayrı GlobalRank, CountryRank ve CategoryRank nesneleri kullanır.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
Ülke sıralamaları
GET https://api.apihop.ai/v1/similarweb/websites/ranks/country
timeGranularity, Monthly değerindedir. Bu, birleşik sıralama yanıtı değil, açık ülke sıralama tablosudur. Satırlar Domain ve Rank ile Data içindedir. Satırlar bulunsa bile TotalCount 0 olabilir; doğrudan Data alanını inceleyin.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
Küresel sıralamalar
GET https://api.apihop.ai/v1/similarweb/websites/ranks/global
timeGranularity, Monthly değerindedir. Ayrı küresel sıralama tablosunu döndürür. Satırlar Domain ve Rank ile Data içindedir. Satırlar bulunsa bile TotalCount 0 olabilir; doğrudan Data alanını inceleyin.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
Kategori sıralamaları
GET https://api.apihop.ai/v1/similarweb/websites/ranks/category
timeGranularity, Monthly değerindedir. Ayrı sektör/kategori sıralama tablosunu döndürür. Satırlar Domain ve Rank ile Data içindedir. Satırlar bulunsa bile TotalCount 0 olabilir; doğrudan Data alanını inceleyin.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
Trafik kanalları
GET https://api.apihop.ai/v1/similarweb/websites/channels
Varsayılan, kayan 28 günlük günlük penceredir. webSource=Total olduğunda kanal değerleri doğrudan Data[domain] altında değil, Data.Total[domain] altındadır. Search - Organic ve Direct gibi kanal adları korunur. Değerler ziyaret sayılarıdır; payları yalnızca toplamları pozitif olduğunda hesaplayın.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Daily, Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
Benzer siteler
GET https://api.apihop.ai/v1/similarweb/websites/similar-sites
Varsayılan önceki üç tam UTC ayıdır. isWindow false olmalıdır, timeGranularity Monthly değerindedir ve orderBy, Affinity desc olarak sabittir. latest veya webSource kabul edilmez.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
timeGranularity | Hayır | Dize; izin verilenler: Monthly |
orderBy | Hayır | Dize; izin verilenler: Affinity desc |
Benzer site önerileri
GET https://api.apihop.ai/v1/similarweb/websites/similar-sites/suggestions
Tekil key kullanılır; limit varsayılan olarak 20'dir ve 1-20 aralığında olmalıdır. country varsayılan olarak 999, webSource ise Total değerindedir. Gözlemlenen yerel yanıt, Domain, DomainWithoutSub, sayısal Rank ve Favicon içeren sarmalanmamış bir aday dizisidir; Data zarfı beklemeyin. Boş dizi öneri içermez. Yalnızca dünya geneli veriler desteklenir (country=999).
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
key | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
limit | Hayır | Tam sayı dizesi; 1-20 |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
Aylık ziyaret geçmişi
GET https://api.apihop.ai/v1/similarweb/websites/history/visits
Varsayılan olarak önceki altı tam UTC ayı kullanılır. Yalnızca country=999, isWindow=false ve timeGranularity=Monthly desteklenir. latest, 1m ile 6m arasındaki değerleri kabul eder; açık tarihler bu kayan altı aylık pencere içinde tam ayları kapsamalıdır. Yerel seriler, Key/Value noktalarıyla Data.<domain>.<source> altında görünebilir; MobileWeb veya Mobile Web dahil kaynak adları korunur. Değerler tahmini ziyaretleri temsil eder.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
Aylık hemen çıkma oranı geçmişi
GET https://api.apihop.ai/v1/similarweb/websites/history/bounce-rate
Varsayılan olarak önceki altı tam UTC ayı kullanılır. Yalnızca country=999, isWindow=false ve timeGranularity=Monthly desteklenir. latest, 1m ile 6m arasındaki değerleri kabul eder; açık tarihler bu kayan altı aylık pencere içinde tam ayları kapsamalıdır. Yerel seriler, Key/Value noktalarıyla Data.<domain>.<source> altında görünebilir; MobileWeb veya Mobile Web dahil kaynak adları korunur. Değerler hemen çıkma oranının kesirli değerlerini temsil eder.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
Aylık ziyaret süresi geçmişi
GET https://api.apihop.ai/v1/similarweb/websites/history/visit-duration
Varsayılan olarak önceki altı tam UTC ayı kullanılır. Yalnızca country=999, isWindow=false ve timeGranularity=Monthly desteklenir. latest, 1m ile 6m arasındaki değerleri kabul eder; açık tarihler bu kayan altı aylık pencere içinde tam ayları kapsamalıdır. Yerel seriler, Key/Value noktalarıyla Data.<domain>.<source> altında görünebilir; MobileWeb veya Mobile Web dahil kaynak adları korunur. Değerler ziyaret başına saniyeyi temsil eder.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
Aylık ziyaret başına sayfa geçmişi
GET https://api.apihop.ai/v1/similarweb/websites/history/pages-per-visit
Varsayılan olarak önceki altı tam UTC ayı kullanılır. Yalnızca country=999, isWindow=false ve timeGranularity=Monthly desteklenir. latest, 1m ile 6m arasındaki değerleri kabul eder; açık tarihler bu kayan altı aylık pencere içinde tam ayları kapsamalıdır. Yerel seriler, Key/Value noktalarıyla Data.<domain>.<source> altında görünebilir; MobileWeb veya Mobile Web dahil kaynak adları korunur. Değerler ziyaret başına sayfa sayısını temsil eder.
| Sorgu alanı | Zorunlu | Tür ve kısıtlamalar |
|---|---|---|
keys | Evet | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |
country | Hayır | Negatif olmayan tam sayı dizesi; Yalnızca dünya geneli veriler desteklenir (country=999). Diğer geçerli ülke değerleri, üst hizmete istek gönderilmeden önce 999 olarak değiştirilir; belirtilen ülkenin değil, dünya genelinin verileri döndürülür. |
from | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
to | Hayır | Dize; yukarıdaki biçimlerde geçerli tarih |
includeSubDomains | Hayır | Boolean dizesi: true veya false |
isWindow | Hayır | Boolean dizesi: true veya false |
webSource | Hayır | Dize; izin verilenler: Total, Desktop, MobileWeb |
timeGranularity | Hayır | Dize; izin verilenler: Monthly |
latest | Hayır | Dize; kenar boşlukları kırpıldıktan sonra 1-2048 UTF-8 bayt |