Documentazione API Hop
Riferimento API Similarweb
Parametri di query, valori predefiniti e formati di risposta nativi degli endpoint Similarweb.
Tutti i percorsi seguenti sono relativi all'origine della tua API. Ogni richiesta richiede Authorization: Bearer YOUR_API_KEY, usa GET e non ha un corpo. Vedi autenticazione, fatturazione ed errori.
Regole delle query
I campi singolari per il sito web key e Key richiedono un unico dominio ASCII come amazon.com, lungo al massimo 253 caratteri, senza spazi iniziali o finali. Non inviare URL, indirizzi IP, elenchi di domini o credenziali API in questi campi. Usa punycode per i domini internazionalizzati.
I nomi dei parametri distinguono maiuscole e minuscole. Campi sconosciuti o duplicati, CR/LF/NUL e valori non validi vengono rifiutati. I valori booleani sono i letterali true o false; zero non è intercambiabile con false. Il testo deve contenere 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni. Codifica spazi, array JSON e separatori con il codificatore di query del tuo client HTTP.
from e to devono comparire insieme, essere date di calendario reali nel formato YYYY-MM-DD o YYYY|MM|DD e soddisfare from <= to. La stessa regola vale per una coppia di confronto. I campi facoltativi ereditano i valori predefiniti dell'endpoint; le tabelle elencano i campi ammessi, non impongono di inviarli tutti.
Negli endpoint che accettano date, un intervallo esplicito from/to valido e completo ha la precedenza. Se l'endpoint accetta latest, il valore fornito deve comunque superare le convalide esistenti del formato e dell'endpoint, ma viene ignorato nella selezione dell'intervallo e non inviato a Similarweb; non viene aggiunto alcun latest predefinito. Senza un intervallo esplicito, il comportamento esistente di latest, valori predefiniti e finestre resta invariato. Restano valide le restrizioni di History; gli endpoint che non accettano latest continuano a rifiutarlo.
Senza un intervallo esplicito from/to: Le route basate su finestre usano normalmente 28 giorni con termine tre giorni UTC fa e accettano da latest=1d a 366d. Le route a mesi fissi usano i valori predefiniti indicati sotto. Interazioni, visite, classifiche e canali accettano anche latest=1m|2m|3m|6m per i mesi di calendario UTC completi precedenti; questi selettori richiedono isWindow=false e usano per impostazione predefinita timeGranularity=Monthly. Lo storico applica le regole più restrittive documentate per i suoi quattro endpoint.
Sono supportati solo dati mondiali (country=999). Gli identificatori dei siti sono domini come example.com, tranne nell'endpoint delle classifiche per parola chiave, dove keys è una parola chiave di ricerca. Disponibilità dei dati, filtri e tipi di corrispondenza del servizio a monte possono variare. Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato.
Le risposte riuscite preservano il JSON nativo invece di adottare uno schema universale. Le tabelle dei referral in entrata e in uscita usano Records; le metriche storiche possono usare Data annidati. I nomi e le unità descritti sotto non implicano che ogni campo facoltativo del servizio a monte sia sempre presente.
Punti di accesso
Suggerimenti di parole chiave
GET https://api.apihop.ai/v1/similarweb/keywords/suggestions
Valori predefiniti: country 999, latest 28d, rowsPerPage 100, type Broad, websource Total e windowVolume decrescente. Il parametro facoltativo page parte da 1. rangeFilter usa la sintassi nativa, per esempio volume,100,10000|difficulty,0,40. La disponibilità dei tipi di corrispondenza e dei filtri dipende dalla sorgente dei dati. Sono supportati solo dati mondiali (country=999).
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keyword | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
sort | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
asc | No | Stringa booleana: true o false |
page | No | Stringa di un intero; 1-1000 |
rowsPerPage | No | Stringa di un intero; 1-1000 |
type | No | Stringa; valori ammessi: Broad, Phrase, Exact, Related |
websource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
isWindow | No | Stringa booleana: true o false |
rangeFilter | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
Collegamenti in entrata
GET https://api.apihop.ai/v1/similarweb/websites/backlinks
Valori predefiniti: Page 1, PageSize 100, Status All, FollowType All e DomainScore decrescente. Key ha l'iniziale maiuscola; non usare key o keys.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
Key | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
Page | No | Stringa di un intero; 1-1000 |
PageSize | No | Stringa di un intero; 1-1000 |
Status | No | Stringa; valori ammessi: All, Active, New, Lost |
FollowType | No | Stringa; valori ammessi: All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow |
DomainScoreFrom | No | Stringa di un intero; 0-100 |
DomainScoreTo | No | Stringa di un intero; 0-100 |
sort | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
asc | No | Stringa booleana: true o false |
Parole chiave del sito
GET https://api.apihop.ai/v1/similarweb/websites/keywords
Valori predefiniti: page 1, pageSize 100, sourceType all ed entrambi i flag del marchio false. pageFilterJson è una singola stringa di array JSON codificata come URL; se omessa, usa keys come dominio. Senza un intervallo esplicito from/to: latest=1m seleziona la panoramica di un mese con pageSize 5 e isWindow=false, salvo indicazione esplicita. Usa sourceType=organic o paid con IncludeNoneBranded=true e IncludeBranded=false per le viste delle parole chiave senza marchio.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Daily, Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
sort | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
asc | No | Stringa booleana: true o false |
iso | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
isDaily | No | Stringa booleana: true o false |
IncludeBranded | No | Stringa booleana: true o false |
IncludeNoneBranded | No | Stringa booleana: true o false |
page | No | Stringa di un intero; 1-1000 |
pageSize | No | Stringa di un intero; 1-1000 |
sourceType | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
pageFilterJson | No | Stringa contenente un array JSON |
Siti posizionati per parola chiave
GET https://api.apihop.ai/v1/similarweb/keywords/websites
keys è una parola chiave, non un dominio web. I valori predefiniti includono selectedPageTab=Organic, sourceType=organic, Device=Total e graphDuration=28d. I parametri facoltativi page e pageSize usano rispettivamente interi a partire da 1 e interi positivi.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Daily, Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
sort | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
asc | No | Stringa booleana: true o false |
iso | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
isDaily | No | Stringa booleana: true o false |
tab | No | Stringa di un intero non negativo |
mtd | No | Stringa booleana: true o false |
selectedPageTab | No | Stringa; valori ammessi: Organic, Paid |
graphDuration | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
graphType | No | Stringa di un intero; 1-1000 |
isDurationChanged | No | Stringa booleana: true o false |
ignoreFilterConsistency | No | Stringa booleana: true o false |
Device | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
sourceType | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
page | No | Stringa di un intero; 1-1000 |
pageSize | No | Stringa di un intero; 1-1000 |
Sorgenti di traffico
GET https://api.apihop.ai/v1/similarweb/websites/traffic-sources
Valori predefiniti: sourceType=Referral, page=1, orderBy=Share desc e timeGranularity=Daily. Questa tabella è distinta dall'endpoint dei referral in entrata.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Daily, Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
sourceType | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
ignoreFilterConsistency | No | Stringa booleana: true o false |
page | No | Stringa di un intero; 1-1000 |
orderBy | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
Traffico in uscita
GET https://api.apihop.ai/v1/similarweb/websites/outgoing-traffic
from e to sono obbligatori. Solo key singolare. Valori predefiniti: country=999, isWWW=false, isWindow=false, webSource=Total, page=1, orderby=Share desc, orderBy=Share desc, sort=Share, asc=false. orderby e orderBy sono distinti e inoltrati indipendentemente; mantienili coerenti. Non sono ammessi latest, pageSize, rowsPerPage, includeSubDomains o timeGranularity. Le righe sono in Records; TotalCount è il totale del servizio a monte, non la lunghezza della pagina corrente. Sono supportati solo dati mondiali (country=999).
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
key | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | Sì | Stringa; data valida nei formati indicati sopra |
to | Sì | Stringa; data valida nei formati indicati sopra |
isWWW | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
orderby | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
orderBy | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
sort | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
asc | No | Stringa booleana: true o false |
page | No | Stringa di un intero; 1-1000 |
Referral in entrata
GET https://api.apihop.ai/v1/similarweb/websites/incoming-referrals
Solo key singolare. Valori predefiniti: country=999, latest=28d, isWWW=false, isWindow=true, isDaily=false, webSource=Total, selectedTab=incomingTraffic, orderBy=TotalShare desc, ignoreFilterConsistency=false, page=1. Non sono ammessi keys, pageSize, rowsPerPage, includeSubDomains o timeGranularity. Le righe sono in Records; i campi nativi possono includere SiteOrigins e TotalShare. Sono supportati solo dati mondiali (country=999).
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
key | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
isWWW | No | Stringa booleana: true o false |
iso | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
isWindow | No | Stringa booleana: true o false |
isDaily | No | Stringa booleana: true o false |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
selectedTab | No | Stringa; valori ammessi: incomingTraffic |
orderBy | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
ignoreFilterConsistency | No | Stringa booleana: true o false |
page | No | Stringa di un intero; 1-1000 |
Quota di parole chiave del marchio
GET https://api.apihop.ai/v1/similarweb/websites/branded-keywords
Il valore predefinito è il mese UTC completo precedente. duration è fissato a 1m.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Daily, Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
duration | No | Stringa; valori ammessi: 1m |
Distribuzione geografica del traffico
GET https://api.apihop.ai/v1/similarweb/websites/geography
I valori predefiniti sono i tre mesi UTC completi precedenti, pageSize=5 e orderBy=TotalShare desc.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Daily, Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
pageSize | No | Stringa di un intero; 1-1000 |
orderBy | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
Distribuzione per dispositivo
GET https://api.apihop.ai/v1/similarweb/websites/devices
I valori predefiniti sono i tre mesi UTC completi precedenti e ShouldGetVerifiedData=false.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Daily, Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
ShouldGetVerifiedData | No | Stringa booleana: true o false |
Rendimento della ricerca
GET https://api.apihop.ai/v1/similarweb/websites/search-performance
I valori predefiniti sono il mese UTC completo precedente, pageSize=5, duration=1m e SourceType=Organic. Usa SourceType=Paid per le parole chiave a pagamento; non sostituirlo con sourceType.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Daily, Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
pageSize | No | Stringa di un intero; 1-1000 |
duration | No | Stringa; valori ammessi: 1m |
SourceType | No | Stringa; valori ammessi: Organic, Paid |
Traffico dai social
GET https://api.apihop.ai/v1/similarweb/websites/social-traffic
Il valore predefinito sono i tre mesi UTC completi precedenti. webSource non è accettato.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
timeGranularity | No | Stringa; valori ammessi: Daily, Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
Panoramica delle interazioni
GET https://api.apihop.ai/v1/similarweb/websites/engagement
I valori predefiniti includono ShouldGetVerifiedData=false, includeLeaders=true e unBounced=false. Le righe native Data possono contenere AvgMonthVisits, BounceRate, PagesPerVisit e AvgVisitDuration.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Daily, Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
ShouldGetVerifiedData | No | Stringa booleana: true o false |
includeLeaders | No | Stringa booleana: true o false |
unBounced | No | Stringa booleana: true o false |
beta | No | Stringa booleana: true o false |
Visite totali
GET https://api.apihop.ai/v1/similarweb/websites/visits
compareFrom e compareTo devono essere forniti insieme come date valide e ordinate. timeGranularity è Monthly. I campi nativi possono includere TotalVisits, Change e ShareOfVisits; un totale mobile non corrisponde necessariamente a un mese di calendario completo.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
compareFrom | No | Stringa; data valida nei formati indicati sopra |
compareTo | No | Stringa; data valida nei formati indicati sopra |
ShouldGetVerifiedData | No | Stringa booleana: true o false |
Tabella delle visite
GET https://api.apihop.ai/v1/similarweb/websites/visits/table
compareFrom e compareTo devono essere forniti insieme come date valide e ordinate. timeGranularity è Monthly; le righe sono in Data, con Domain e TotalVisits. TotalCount può essere 0 anche quando Data contiene righe; controlla l'array stesso per determinare se sono presenti risultati.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
compareFrom | No | Stringa; data valida nei formati indicati sopra |
compareTo | No | Stringa; data valida nei formati indicati sopra |
ShouldGetVerifiedData | No | Stringa booleana: true o false |
Andamento delle visite
GET https://api.apihop.ai/v1/similarweb/websites/visits/trend
La finestra predefinita è mobile di 28 giorni con dati giornalieri. timeGranularity accetta Daily, Weekly o Monthly.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Daily, Weekly, Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
ShouldGetVerifiedData | No | Stringa booleana: true o false |
Classifiche dei siti
GET https://api.apihop.ai/v1/similarweb/websites/ranks
timeGranularity è Monthly. La risposta nativa usa oggetti distinti GlobalRank, CountryRank e CategoryRank.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
Classifiche nazionali
GET https://api.apihop.ai/v1/similarweb/websites/ranks/country
timeGranularity è Monthly. Questa è la tabella esplicita della classifica nazionale, non la risposta combinata delle classifiche. Le righe sono in Data, con Domain e Rank. TotalCount può essere 0 anche in presenza di righe; controlla direttamente Data.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
Classifiche globali
GET https://api.apihop.ai/v1/similarweb/websites/ranks/global
timeGranularity è Monthly. Restituisce la tabella separata della classifica globale. Le righe sono in Data, con Domain e Rank. TotalCount può essere 0 anche in presenza di righe; controlla direttamente Data.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
Classifiche per categoria
GET https://api.apihop.ai/v1/similarweb/websites/ranks/category
timeGranularity è Monthly. Restituisce la tabella separata della classifica per settore/categoria. Le righe sono in Data, con Domain e Rank. TotalCount può essere 0 anche in presenza di righe; controlla direttamente Data.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
Canali di traffico
GET https://api.apihop.ai/v1/similarweb/websites/channels
La finestra predefinita è mobile di 28 giorni con dati giornalieri. Con webSource=Total, i valori dei canali si trovano sotto Data.Total[domain], non direttamente sotto Data[domain]. I nomi dei canali, per esempio Search - Organic e Direct, vengono preservati. I valori sono conteggi delle visite; ricava le quote solo quando la loro somma è positiva.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Daily, Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
Siti simili
GET https://api.apihop.ai/v1/similarweb/websites/similar-sites
Il valore predefinito sono i tre mesi UTC completi precedenti. isWindow deve essere false, timeGranularity è Monthly e orderBy è fissato a Affinity desc. Non sono ammessi latest o webSource.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
timeGranularity | No | Stringa; valori ammessi: Monthly |
orderBy | No | Stringa; valori ammessi: Affinity desc |
Suggerimenti di siti simili
GET https://api.apihop.ai/v1/similarweb/websites/similar-sites/suggestions
key singolare; limit è 20 per impostazione predefinita e deve essere 1-20. country è 999 per impostazione predefinita e webSource è Total. La risposta nativa osservata è un array non incapsulato di candidati con Domain, DomainWithoutSub, Rank numerico e Favicon; non aspettarti un contenitore Data. Un array vuoto non contiene suggerimenti. Sono supportati solo dati mondiali (country=999).
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
key | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
limit | No | Stringa di un intero; 1-20 |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
Storico mensile delle visite
GET https://api.apihop.ai/v1/similarweb/websites/history/visits
Per impostazione predefinita vengono usati i sei mesi UTC completi precedenti. Sono supportati solo country=999, isWindow=false e timeGranularity=Monthly. latest accetta da 1m a 6m; le date esplicite devono coprire mesi completi all'interno di questa finestra mobile di sei mesi. Le serie native possono comparire sotto Data.<domain>.<source> con punti Key/Value; i nomi delle sorgenti, inclusi MobileWeb o Mobile Web, vengono preservati. I valori rappresentano visite stimate.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
Storico mensile della frequenza di rimbalzo
GET https://api.apihop.ai/v1/similarweb/websites/history/bounce-rate
Per impostazione predefinita vengono usati i sei mesi UTC completi precedenti. Sono supportati solo country=999, isWindow=false e timeGranularity=Monthly. latest accetta da 1m a 6m; le date esplicite devono coprire mesi completi all'interno di questa finestra mobile di sei mesi. Le serie native possono comparire sotto Data.<domain>.<source> con punti Key/Value; i nomi delle sorgenti, inclusi MobileWeb o Mobile Web, vengono preservati. I valori rappresentano frazioni della frequenza di rimbalzo.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
Storico mensile della durata delle visite
GET https://api.apihop.ai/v1/similarweb/websites/history/visit-duration
Per impostazione predefinita vengono usati i sei mesi UTC completi precedenti. Sono supportati solo country=999, isWindow=false e timeGranularity=Monthly. latest accetta da 1m a 6m; le date esplicite devono coprire mesi completi all'interno di questa finestra mobile di sei mesi. Le serie native possono comparire sotto Data.<domain>.<source> con punti Key/Value; i nomi delle sorgenti, inclusi MobileWeb o Mobile Web, vengono preservati. I valori rappresentano secondi per visita.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
Storico mensile delle pagine per visita
GET https://api.apihop.ai/v1/similarweb/websites/history/pages-per-visit
Per impostazione predefinita vengono usati i sei mesi UTC completi precedenti. Sono supportati solo country=999, isWindow=false e timeGranularity=Monthly. latest accetta da 1m a 6m; le date esplicite devono coprire mesi completi all'interno di questa finestra mobile di sei mesi. Le serie native possono comparire sotto Data.<domain>.<source> con punti Key/Value; i nomi delle sorgenti, inclusi MobileWeb o Mobile Web, vengono preservati. I valori rappresentano pagine per visita.
| Campo della query | Obbligatorio | Tipo e vincoli |
|---|---|---|
keys | Sì | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |
country | No | Stringa di un intero non negativo; Sono supportati solo dati mondiali (country=999). Gli altri valori di paese validi vengono sostituiti con 999 prima della richiesta al fornitore e restituiscono dati mondiali, non del paese indicato. |
from | No | Stringa; data valida nei formati indicati sopra |
to | No | Stringa; data valida nei formati indicati sopra |
includeSubDomains | No | Stringa booleana: true o false |
isWindow | No | Stringa booleana: true o false |
webSource | No | Stringa; valori ammessi: Total, Desktop, MobileWeb |
timeGranularity | No | Stringa; valori ammessi: Monthly |
latest | No | Stringa; 1-2048 byte UTF-8 dopo la rimozione degli spazi esterni |