API Hop

Dokumentation

API Hop-Dokumentation

Similarweb API-Referenz

Abfrageparameter, Standardwerte und native Antwortformate der Similarweb-Endpunkte.

Alle folgenden Pfade sind relativ zu Ihrem API-Ursprung. Jede Anfrage erfordert Authorization: Bearer YOUR_API_KEY, verwendet GET und hat keinen Anfragekörper. Siehe Authentifizierung, Abrechnung und Fehler.

Abfrageregeln

Die einzelnen Website-Felder key und Key erfordern genau eine ASCII-Domain wie amazon.com mit höchstens 253 Zeichen und ohne umgebende Leerzeichen. Senden Sie in diesen Feldern keine URL, IP-Adresse, Domainliste oder API-Zugangsdaten. Verwenden Sie für internationalisierte Domains Punycode.

Parameternamen unterscheiden Groß- und Kleinschreibung. Unbekannte oder doppelte Felder, CR/LF/NUL und ungültige Werte werden abgelehnt. Boolesche Werte sind die Literale true oder false; null ist nicht mit false austauschbar. Text umfasst nach dem Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes. Kodieren Sie Leerzeichen, JSON-Arrays und Trennzeichen mit dem Abfrage-Encoder Ihres HTTP-Clients.

from und to müssen gemeinsam vorkommen, gültige Kalenderdaten im Format YYYY-MM-DD oder YYYY|MM|DD sein und from <= to erfüllen. Für ein Vergleichspaar gilt dieselbe Regel. Optionale Felder übernehmen die Standardwerte des Endpunkts; die Tabellen nennen zulässige Felder und verlangen nicht, dass Sie alle senden.

Bei Endpunkten mit Datumsparametern hat ein gültiger, vollständiger expliziter from/to-Zeitraum Vorrang. Akzeptiert der Endpunkt latest, muss ein angegebener Wert weiterhin die bestehende Format- und endpunktspezifische Validierung bestehen, wird aber bei der Zeitraumwahl ignoriert und nicht an Similarweb gesendet; ein Standardwert für latest wird nicht ergänzt. Ohne expliziten Zeitraum bleiben das bisherige latest-, Standardwert- und Fensterverhalten unverändert. Die History-Einschränkungen gelten weiterhin; Endpunkte ohne latest lehnen dieses Feld weiterhin ab.

Ohne expliziten from/to-Zeitraum: Fensterbasierte Routen verwenden normalerweise ein 28-Tage-Fenster, das vor drei UTC-Tagen endet, und akzeptieren latest=1d bis 366d. Routen mit festen Monaten verwenden die unten angegebenen Standardwerte. Interaktion, Besuche, Rankings und Kanäle akzeptieren zusätzlich latest=1m|2m|3m|6m für vorherige vollständige UTC-Kalendermonate; diese Selektoren erfordern isWindow=false und verwenden standardmäßig timeGranularity=Monthly. Für Verlaufsdaten gelten die engeren Regeln der vier entsprechenden Endpunkte.

Es werden nur weltweite Daten unterstützt (country=999). Website-Kennungen sind Domains wie example.com, außer beim Keyword-Ranking-Endpunkt, wo keys ein Suchbegriff ist. Datenverfügbarkeit, Filter und Übereinstimmungstypen des vorgelagerten Dienstes können variieren. Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.

Erfolgreiche Antworten behalten natives JSON bei, statt ein universelles Antwortschema zu verwenden. Tabellen für eingehende und ausgehende Verweise verwenden Records; historische Kennzahlen können verschachtelte Data verwenden. Die folgenden Namen und Einheiten bedeuten nicht, dass jedes optionale Feld des vorgelagerten Dienstes immer vorhanden ist.

API-Endpunkte

Keyword-Vorschläge

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

Standardwerte: country 999, latest 28d, rowsPerPage 100, type Broad, websource Total und windowVolume absteigend. Das optionale page beginnt bei 1. rangeFilter verwendet native Syntax, zum Beispiel volume,100,10000|difficulty,0,40. Die Verfügbarkeit von Übereinstimmungstypen und Filtern hängt von der Datenquelle ab. Es werden nur weltweite Daten unterstützt (country=999).

AbfragefeldErforderlichTyp und Einschränkungen
keywordJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
sortNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
ascNeinBoolesche Zeichenfolge: true oder false
pageNeinGanzzahl als Zeichenfolge; 1-1000
rowsPerPageNeinGanzzahl als Zeichenfolge; 1-1000
typeNeinZeichenfolge; Aufzählung: Broad, Phrase, Exact, Related
websourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
isWindowNeinBoolesche Zeichenfolge: true oder false
rangeFilterNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes

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

Standardwerte: Page 1, PageSize 100, Status All, FollowType All und DomainScore absteigend. Key wird großgeschrieben; verwenden Sie weder key noch keys.

AbfragefeldErforderlichTyp und Einschränkungen
KeyJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
PageNeinGanzzahl als Zeichenfolge; 1-1000
PageSizeNeinGanzzahl als Zeichenfolge; 1-1000
StatusNeinZeichenfolge; Aufzählung: All, Active, New, Lost
FollowTypeNeinZeichenfolge; Aufzählung: All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow
DomainScoreFromNeinGanzzahl als Zeichenfolge; 0-100
DomainScoreToNeinGanzzahl als Zeichenfolge; 0-100
sortNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
ascNeinBoolesche Zeichenfolge: true oder false

Website-Keywords

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

Standardwerte: page 1, pageSize 100, sourceType all und beide Marken-Flags false. pageFilterJson ist eine URL-kodierte JSON-Array-Zeichenfolge; ohne dieses Feld wird keys als Domain verwendet. Ohne expliziten from/to-Zeitraum: latest=1m wählt den einmonatigen Übersichtsmodus mit pageSize 5 und isWindow=false, sofern nicht ausdrücklich anders angegeben. Verwenden Sie sourceType=organic oder paid mit IncludeNoneBranded=true und IncludeBranded=false für Ansichten nicht markenbezogener Keywords.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Daily, Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
sortNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
ascNeinBoolesche Zeichenfolge: true oder false
isoNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
isDailyNeinBoolesche Zeichenfolge: true oder false
IncludeBrandedNeinBoolesche Zeichenfolge: true oder false
IncludeNoneBrandedNeinBoolesche Zeichenfolge: true oder false
pageNeinGanzzahl als Zeichenfolge; 1-1000
pageSizeNeinGanzzahl als Zeichenfolge; 1-1000
sourceTypeNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
pageFilterJsonNeinZeichenfolge mit einem JSON-Array

Für Keywords platzierte Websites

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

keys ist ein Keyword, keine Website-Domain. Zu den Standardwerten gehören selectedPageTab=Organic, sourceType=organic, Device=Total und graphDuration=28d. Die optionalen Felder page und pageSize verwenden bei 1 beginnende beziehungsweise positive Ganzzahlen.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Daily, Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
sortNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
ascNeinBoolesche Zeichenfolge: true oder false
isoNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
isDailyNeinBoolesche Zeichenfolge: true oder false
tabNeinNichtnegative Ganzzahl als Zeichenfolge
mtdNeinBoolesche Zeichenfolge: true oder false
selectedPageTabNeinZeichenfolge; Aufzählung: Organic, Paid
graphDurationNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
graphTypeNeinGanzzahl als Zeichenfolge; 1-1000
isDurationChangedNeinBoolesche Zeichenfolge: true oder false
ignoreFilterConsistencyNeinBoolesche Zeichenfolge: true oder false
DeviceNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
sourceTypeNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
pageNeinGanzzahl als Zeichenfolge; 1-1000
pageSizeNeinGanzzahl als Zeichenfolge; 1-1000

Traffic-Quellen

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

Standardwerte: sourceType=Referral, page=1, orderBy=Share desc und timeGranularity=Daily. Diese Tabelle unterscheidet sich vom Endpunkt für eingehende Verweise.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Daily, Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
sourceTypeNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
ignoreFilterConsistencyNeinBoolesche Zeichenfolge: true oder false
pageNeinGanzzahl als Zeichenfolge; 1-1000
orderByNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes

Ausgehender Traffic

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

from und to sind erforderlich. Nur das einzelne key wird akzeptiert. Standardwerte: country=999, isWWW=false, isWindow=false, webSource=Total, page=1, orderby=Share desc, orderBy=Share desc, sort=Share, asc=false. orderby und orderBy sind unterschiedliche Felder und werden unabhängig weitergereicht; halten Sie sie konsistent. Keine Unterstützung für latest, pageSize, rowsPerPage, includeSubDomains oder timeGranularity. Zeilen stehen in Records; TotalCount ist die Gesamtzahl des vorgelagerten Dienstes, nicht die Länge der aktuellen Seite. Es werden nur weltweite Daten unterstützt (country=999).

AbfragefeldErforderlichTyp und Einschränkungen
keyJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromJaZeichenfolge; gültiges Datum in einem der obigen Formate
toJaZeichenfolge; gültiges Datum in einem der obigen Formate
isWWWNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
orderbyNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
orderByNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
sortNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
ascNeinBoolesche Zeichenfolge: true oder false
pageNeinGanzzahl als Zeichenfolge; 1-1000

Eingehende Verweise

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

Nur das einzelne key wird akzeptiert. Standardwerte: country=999, latest=28d, isWWW=false, isWindow=true, isDaily=false, webSource=Total, selectedTab=incomingTraffic, orderBy=TotalShare desc, ignoreFilterConsistency=false, page=1. Keine Unterstützung für keys, pageSize, rowsPerPage, includeSubDomains oder timeGranularity. Zeilen stehen in Records; native Felder können SiteOrigins und TotalShare enthalten. Es werden nur weltweite Daten unterstützt (country=999).

AbfragefeldErforderlichTyp und Einschränkungen
keyJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
isWWWNeinBoolesche Zeichenfolge: true oder false
isoNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
isWindowNeinBoolesche Zeichenfolge: true oder false
isDailyNeinBoolesche Zeichenfolge: true oder false
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
selectedTabNeinZeichenfolge; Aufzählung: incomingTraffic
orderByNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
ignoreFilterConsistencyNeinBoolesche Zeichenfolge: true oder false
pageNeinGanzzahl als Zeichenfolge; 1-1000

Anteil markenbezogener Keywords

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

Standardmäßig wird der vorherige vollständige UTC-Monat verwendet. duration ist auf 1m festgelegt.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Daily, Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
durationNeinZeichenfolge; Aufzählung: 1m

Geografische Traffic-Verteilung

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

Standardmäßig werden die vorherigen drei vollständigen UTC-Monate mit pageSize=5 und orderBy=TotalShare desc verwendet.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Daily, Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
pageSizeNeinGanzzahl als Zeichenfolge; 1-1000
orderByNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes

Geräteverteilung

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

Standardmäßig werden die vorherigen drei vollständigen UTC-Monate und ShouldGetVerifiedData=false verwendet.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Daily, Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
ShouldGetVerifiedDataNeinBoolesche Zeichenfolge: true oder false

Suchleistung

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

Standardmäßig werden der vorherige vollständige UTC-Monat, pageSize=5, duration=1m und SourceType=Organic verwendet. Verwenden Sie SourceType=Paid für bezahlte Keywords; ersetzen Sie es nicht durch sourceType.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Daily, Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
pageSizeNeinGanzzahl als Zeichenfolge; 1-1000
durationNeinZeichenfolge; Aufzählung: 1m
SourceTypeNeinZeichenfolge; Aufzählung: Organic, Paid

Traffic aus sozialen Netzwerken

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

Standardmäßig werden die vorherigen drei vollständigen UTC-Monate verwendet. webSource wird nicht akzeptiert.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
timeGranularityNeinZeichenfolge; Aufzählung: Daily, Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes

Interaktionsübersicht

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

Zu den Standardwerten gehören ShouldGetVerifiedData=false, includeLeaders=true und unBounced=false. Native Data-Zeilen können AvgMonthVisits, BounceRate, PagesPerVisit und AvgVisitDuration enthalten.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Daily, Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
ShouldGetVerifiedDataNeinBoolesche Zeichenfolge: true oder false
includeLeadersNeinBoolesche Zeichenfolge: true oder false
unBouncedNeinBoolesche Zeichenfolge: true oder false
betaNeinBoolesche Zeichenfolge: true oder false

Besuche insgesamt

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

compareFrom und compareTo müssen gemeinsam als gültige, chronologisch geordnete Daten angegeben werden. timeGranularity ist Monthly. Native Felder können TotalVisits, Change und ShareOfVisits enthalten; eine rollierende Gesamtsumme entspricht nicht zwingend der Summe eines vollständigen Kalendermonats.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
compareFromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
compareToNeinZeichenfolge; gültiges Datum in einem der obigen Formate
ShouldGetVerifiedDataNeinBoolesche Zeichenfolge: true oder false

Besuchstabelle

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

compareFrom und compareTo müssen gemeinsam als gültige, chronologisch geordnete Daten angegeben werden. timeGranularity ist Monthly; Zeilen stehen in Data mit Domain und TotalVisits. TotalCount kann 0 sein, obwohl Data Zeilen enthält; prüfen Sie das Array selbst, um festzustellen, ob Ergebnisse vorhanden sind.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
compareFromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
compareToNeinZeichenfolge; gültiges Datum in einem der obigen Formate
ShouldGetVerifiedDataNeinBoolesche Zeichenfolge: true oder false

Besuchstrend

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

Standardmäßig wird das rollierende 28-Tage-Fenster mit Tageswerten verwendet. timeGranularity akzeptiert Daily, Weekly oder Monthly.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Daily, Weekly, Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
ShouldGetVerifiedDataNeinBoolesche Zeichenfolge: true oder false

Website-Rankings

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

timeGranularity ist Monthly. Die native Antwort verwendet separate Objekte für GlobalRank, CountryRank und CategoryRank.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes

Länder-Rankings

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

timeGranularity ist Monthly. Dies ist die ausdrückliche Länder-Ranking-Tabelle, nicht die kombinierte Ranking-Antwort. Zeilen stehen in Data mit Domain und Rank. TotalCount kann auch bei vorhandenen Zeilen 0 sein; prüfen Sie Data direkt.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes

Globale Rankings

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

timeGranularity ist Monthly. Dies liefert die separate globale Ranking-Tabelle. Zeilen stehen in Data mit Domain und Rank. TotalCount kann auch bei vorhandenen Zeilen 0 sein; prüfen Sie Data direkt.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes

Kategorie-Rankings

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

timeGranularity ist Monthly. Dies liefert die separate Branchen-/Kategorie-Ranking-Tabelle. Zeilen stehen in Data mit Domain und Rank. TotalCount kann auch bei vorhandenen Zeilen 0 sein; prüfen Sie Data direkt.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes

Traffic-Kanäle

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

Standardmäßig wird das rollierende 28-Tage-Fenster mit Tageswerten verwendet. Bei webSource=Total stehen Kanalwerte unter Data.Total[domain], nicht direkt unter Data[domain]. Kanalnamen wie Search - Organic und Direct bleiben erhalten. Die Werte sind Besuchszahlen; berechnen Sie Anteile nur bei einer positiven Summe.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Daily, Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes

Ähnliche Websites

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

Standardmäßig werden die vorherigen drei vollständigen UTC-Monate verwendet. isWindow muss false sein, timeGranularity ist Monthly und orderBy ist auf Affinity desc festgelegt. Keine Unterstützung für latest oder webSource.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
timeGranularityNeinZeichenfolge; Aufzählung: Monthly
orderByNeinZeichenfolge; Aufzählung: Affinity desc

Vorschläge ähnlicher Websites

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

Einzelnes key; limit beträgt standardmäßig 20 und muss zwischen 1-20 liegen. country ist standardmäßig 999 und webSource Total. Die beobachtete native Antwort ist ein nicht umschlossenes Kandidaten-Array mit Domain, DomainWithoutSub, numerischem Rank und Favicon; erwarten Sie keine Data-Hülle. Ein leeres Array enthält keine Vorschläge. Es werden nur weltweite Daten unterstützt (country=999).

AbfragefeldErforderlichTyp und Einschränkungen
keyJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
limitNeinGanzzahl als Zeichenfolge; 1-20
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb

Monatlicher Besuchsverlauf

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

Standardmäßig werden die letzten sechs vollständigen UTC-Monate verwendet. Unterstützt werden nur country=999, isWindow=false und timeGranularity=Monthly. latest akzeptiert 1m bis 6m; explizite Datumsangaben müssen vollständige Monate innerhalb dieses rollierenden Sechsmonatsfensters abdecken. Native Reihen können unter Data.<domain>.<source> mit Key/Value-Punkten erscheinen; Quellnamen wie MobileWeb oder Mobile Web bleiben erhalten. Die Werte stellen geschätzte Besuche dar.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes

Monatlicher Verlauf der Absprungrate

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

Standardmäßig werden die letzten sechs vollständigen UTC-Monate verwendet. Unterstützt werden nur country=999, isWindow=false und timeGranularity=Monthly. latest akzeptiert 1m bis 6m; explizite Datumsangaben müssen vollständige Monate innerhalb dieses rollierenden Sechsmonatsfensters abdecken. Native Reihen können unter Data.<domain>.<source> mit Key/Value-Punkten erscheinen; Quellnamen wie MobileWeb oder Mobile Web bleiben erhalten. Die Werte stellen Bruchteile der Absprungrate dar.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes

Monatlicher Verlauf der Besuchsdauer

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

Standardmäßig werden die letzten sechs vollständigen UTC-Monate verwendet. Unterstützt werden nur country=999, isWindow=false und timeGranularity=Monthly. latest akzeptiert 1m bis 6m; explizite Datumsangaben müssen vollständige Monate innerhalb dieses rollierenden Sechsmonatsfensters abdecken. Native Reihen können unter Data.<domain>.<source> mit Key/Value-Punkten erscheinen; Quellnamen wie MobileWeb oder Mobile Web bleiben erhalten. Die Werte stellen Sekunden pro Besuch dar.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes

Monatlicher Verlauf der Seiten pro Besuch

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

Standardmäßig werden die letzten sechs vollständigen UTC-Monate verwendet. Unterstützt werden nur country=999, isWindow=false und timeGranularity=Monthly. latest akzeptiert 1m bis 6m; explizite Datumsangaben müssen vollständige Monate innerhalb dieses rollierenden Sechsmonatsfensters abdecken. Native Reihen können unter Data.<domain>.<source> mit Key/Value-Punkten erscheinen; Quellnamen wie MobileWeb oder Mobile Web bleiben erhalten. Die Werte stellen Seiten pro Besuch dar.

AbfragefeldErforderlichTyp und Einschränkungen
keysJaZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes
countryNeinNichtnegative Ganzzahl als Zeichenfolge; Es werden nur weltweite Daten unterstützt (country=999). Andere gültige Länderwerte werden vor der Upstream-Anfrage in 999 geändert; zurückgegeben werden weltweite Daten, keine Daten des angegebenen Landes.
fromNeinZeichenfolge; gültiges Datum in einem der obigen Formate
toNeinZeichenfolge; gültiges Datum in einem der obigen Formate
includeSubDomainsNeinBoolesche Zeichenfolge: true oder false
isWindowNeinBoolesche Zeichenfolge: true oder false
webSourceNeinZeichenfolge; Aufzählung: Total, Desktop, MobileWeb
timeGranularityNeinZeichenfolge; Aufzählung: Monthly
latestNeinZeichenfolge; nach Entfernen äußerer Leerzeichen 1-2048 UTF-8-Bytes