API Similarweb: opis punktów końcowych | Dokumentacja API

# SimilarwebAPI endpoint reference

All 27 SimilarwebAPI GET endpoints with exact query names, types, limits, date windows, and response behavior.

All paths below are relative to your API origin. Every request requires `Authorization: Bearer YOUR_API_KEY`, uses GET, and has no request body. See [authentication, billing, and errors](https://apihop.ai/en/docs/api-reference/similarweb/overview).

## Query Rules

The singular website fields `key` and `Key` require one ASCII domain such as `amazon.com`, up to 253 characters, without surrounding whitespace. Do not send a URL, IP address, domain list, or API credential in these fields. Use punycode for internationalized domains.

Query names are case-sensitive. Unknown fields, duplicate fields, CR/LF/NUL, and invalid values are rejected. Boolean values are literal `true` or `false`; zero is not interchangeable with false. Text is 1-2048 UTF-8 bytes after trimming. Encode spaces, JSON arrays, and separators with your HTTP client's query encoder.

`from` and `to` must occur together, be real calendar dates in `YYYY-MM-DD` or `YYYY|MM|DD` format, and satisfy `from <= to`. A comparison pair follows the same rule. Optional fields inherit endpoint defaults; the tables list allowed fields, not a requirement to send all of them.

For endpoints that accept dates, a valid, complete explicit `from`/`to` range takes precedence. On endpoints that accept `latest`, a supplied value must still pass the existing format and endpoint-specific validation, but is ignored for range selection and is not sent to Similarweb; no default `latest` is added. Without an explicit range, existing `latest`, default and window behavior is unchanged. History restrictions still apply, and endpoints that do not accept `latest` still reject it.

Without an explicit `from`/`to` range: Window-based routes normally default to 28 days ending three UTC days ago and accept `latest=1d` through `366d`. Fixed-month routes have the defaults noted below. Engagement, visits, ranks, and channels additionally accept `latest=1m|2m|3m|6m` for previous complete UTC calendar months; these selectors require `isWindow=false` and default `timeGranularity=Monthly`. History has the narrower rules documented for its four endpoints.

Only worldwide data is supported (`country=999`). Website identifiers are domains such as `example.com`, except the keyword-ranking endpoint where `keys` is a search keyword. Upstream data availability, filters, and matching types may vary. Other valid country values are changed to `999` before the upstream request and return worldwide, not country-specific, data.

Successful responses preserve native JSON rather than adopting a universal response schema. Incoming and outgoing referral tables use `Records`; historical metrics may use nested `Data`. The names and units described below do not imply every optional upstream field is always present.

## Endpoints

### Keyword suggestions

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

Defaults: country 999, latest 28d, rowsPerPage 100, type Broad, websource Total, and windowVolume descending. Optional page is 1-based. rangeFilter uses native syntax, for example volume,100,10000|difficulty,0,40. Matching-type and filter availability depend on the data source. Only worldwide data is supported (`country=999`).

| Query field | Required | Type and constraints |
| --- | --- | --- |
| `keyword` | Yes | string; 1-2048 UTF-8 bytes after trimming |
| `country` | No | nonnegative integer string; Only worldwide data is supported (`country=999`). Other valid country values are changed to `999` before the upstream request and return worldwide, not country-specific, data. |
| `from` | No | string; valid date using the formats above |
| `to` | No | string; valid date using the formats above |
| `latest` | No | string; 1-2048 UTF-8 bytes after trimming |
| `sort` | No | string; 1-2048 UTF-8 bytes after trimming |
| `asc` | No | boolean string: true or false |
| `page` | No | integer string; 1-1000 |
| `rowsPerPage` | No | integer string; 1-1000 |
| `type` | No | string; enum: Broad, Phrase, Exact, Related |
| `websource` | No | string; enum: Total, Desktop, MobileWeb |
| `isWindow` | No | boolean string: true or false |
| `rangeFilter` | No | string; 1-2048 UTF-8 bytes after trimming |

### Backlinks

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

Defaults: Page 1, PageSize 100, Status All, FollowType All, and DomainScore descending. Key is capitalized; do not use key or keys.

| Query field | Required | Type and constraints |
| --- | --- | --- |
| `Key` | Yes | string; 1-2048 UTF-8 bytes after trimming |
| `Page` | No | integer string; 1-1000 |
| `PageSize` | No | integer string; 1-1000 |
| `Status` | No | string; enum: All, Active, New, Lost |
| `FollowType` | No | string; enum: All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow |
| `DomainScoreFrom` | No | integer string; 0-100 |
| `DomainScoreTo` | No | integer string; 0-100 |
| `sort` | No | string; 1-2048 UTF-8 bytes after trimming |
| `asc` | No | boolean string: true or false |

### Website keywords

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

Defaults: page 1, pageSize 100, sourceType all, and both branded flags false. pageFilterJson is one URL-encoded JSON array string; when omitted it targets keys as a domain. Without an explicit `from`/`to` range: latest=1m selects the one-month overview mode with pageSize 5 and isWindow=false unless explicitly provided. Use sourceType=organic or paid with IncludeNoneBranded=true and IncludeBranded=false for non-branded keyword views.

| Query field | Required | Type and constraints |
| --- | --- | --- |
| `keys` | Yes | string; 1-2048 UTF-8 bytes after trimming |
| `country` | No | nonnegative integer string; Only worldwide data is supported (`country=999`). Other valid country values are changed to `999` before the upstream request and return worldwide, not country-specific, data. |
| `from` | No | string; valid date using the formats above |
| `to` | No | string; valid date using the formats above |
| `includeSubDomains` | No | boolean string: true or false |
| `isWindow` | No | boolean string: true or false |
| `webSource` | No | string; enum: Total, Desktop, MobileWeb |
| `timeGranularity` | No | string; enum: Daily, Monthly |
| `latest` | No | string; 1-2048 UTF-8 bytes after trimming |
| `sort` | No | string; 1-2048 UTF-8 bytes after trimming |
| `asc` | No | boolean string: true or false |
| `iso` | No | string; 1-2048 UTF-8 bytes after trimming |
| `isDaily` | No | boolean string: true or false |
| `IncludeBranded` | No | boolean string: true or false |
| `IncludeNoneBranded` | No | boolean string: true or false |
| `page` | No | integer string; 1-1000 |
| `pageSize` | No | integer string; 1-1000 |
| `sourceType` | No | string; 1-2048 UTF-8 bytes after trimming |
| `pageFilterJson` | No | string containing a JSON array |

### Keyword ranking websites

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

keys is a keyword, not a website domain. Defaults include selectedPageTab=Organic, sourceType=organic, Device=Total, and graphDuration=28d. Optional page and pageSize use 1-based/positive integers.

| Query field | Required | Type and constraints |
| --- | --- | --- |
| `keys` | Yes | string; 1-2048 UTF-8 bytes after trimming |
| `country` | No | nonnegative integer string; Only worldwide data is supported (`country=999`). Other valid country values are changed to `999` before the upstream request and return worldwide, not country-specific, data. |
| `from` | No | string; valid date using the formats above |
| `to` | No | string; valid date using the formats above |
| `includeSubDomains` | No | boolean string: true or false |
| `isWindow` | No | boolean string: true or false |
| `webSource` | No | string; enum: Total, Desktop, MobileWeb |
| `timeGranularity` | No | string; enum: Daily, Monthly |
| `latest` | No | string; 1-2048 UTF-8 bytes after trimming |
| `sort` | No | string; 1-2048 UTF-8 bytes after trimming |
| `asc` | No | boolean string: true or false |
| `iso` | No | string; 1-2048 UTF-8 bytes after trimming |
| `isDaily` | No | boolean string: true or false |
| `tab` | No | nonnegative integer string |
| `mtd` | No | boolean string: true or false |
| `selectedPageTab` | No | string; enum: Organic, Paid |
| `graphDuration` | No | string; 1-2048 UTF-8 bytes after trimming |
| `graphType` | No | integer string; 1-1000 |
| `isDurationChanged` | No | boolean string: true or false |
| `ignoreFilterConsistency` | No | boolean string: true or false |
| `Device` | No | string; 1-2048 UTF-8 bytes after trimming |
| `sourceType` | No | string; 1-2048 UTF-8 bytes after trimming |
| `page` | No | integer string; 1-1000 |
| `pageSize` | No | integer string; 1-1000 |

### Traffic sources

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

Defaults: sourceType=Referral, page=1, orderBy=Share desc, and timeGranularity=Daily. This table is distinct from the incoming-referrals endpoint.

### Outgoing traffic

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

from and to are required. Singular key only. Defaults: country=999, isWWW=false, isWindow=false, webSource=Total, page=1, orderby=Share desc, orderBy=Share desc, sort=Share, asc=false. orderby and orderBy are distinct and forwarded independently; keep them consistent. No latest, pageSize, rowsPerPage, includeSubDomains, or timeGranularity. Rows are in Records; TotalCount is the upstream total, not the current page length. Only worldwide data is supported (`country=999`).

| Query field | Required | Type and constraints |
| --- | --- | --- |
| `key` | Yes | string; 1-2048 UTF-8 bytes after trimming |
| `country` | No | nonnegative integer string; Only worldwide data is supported (`country=999`). Other valid country values are changed to `999` before the upstream request and return worldwide, not country-specific, data. |
| `from` | Yes | string; valid date using the formats above |
| `to` | Yes | string; valid date using the formats above |
| `isWWW` | No | boolean string: true or false |
| `isWindow` | No | boolean string: true or false |
| `webSource` | No | string; enum: Total, Desktop, MobileWeb |
| `orderby` | No | string; 1-2048 UTF-8 bytes after trimming |
| `orderBy` | No | string; 1-2048 UTF-8 bytes after trimming |
| `sort` | No | string; 1-2048 UTF-8 bytes after trimming |
| `asc` | No | boolean string: true or false |
| `page` | No | integer string; 1-1000 |

### Incoming referrals

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

Singular key only. Defaults: country=999, latest=28d, isWWW=false, isWindow=true, isDaily=false, webSource=Total, selectedTab=incomingTraffic, orderBy=TotalShare desc, ignoreFilterConsistency=false, page=1. No keys, pageSize, rowsPerPage, includeSubDomains, or timeGranularity. Rows are in Records; native fields may include SiteOrigins and TotalShare. Only worldwide data is supported (`country=999`).

| Query field | Required | Type and constraints |
| --- | --- | --- |
| `key` | Yes | string; 1-2048 UTF-8 bytes after trimming |
| `country` | No | nonnegative integer string; Only worldwide data is supported (`country=999`). Other valid country values are changed to `999` before the upstream request and return worldwide, not country-specific, data. |
| `from` | No | string; valid date using the formats above |
| `to` | No | string; valid date using the formats above |
| `isWWW` | No | boolean string: true or false |
| `iso` | No | string; 1-2048 UTF-8 bytes after trimming |
| `isWindow` | No | boolean string: true or false |
| `isDaily` | No | boolean string: true or false |
| `latest` | No | string; 1-2048 UTF-8 bytes after trimming |
| `webSource` | No | string; enum: Total, Desktop, MobileWeb |
| `selectedTab` | No | string; enum: incomingTraffic |
| `orderBy` | No | string; 1-2048 UTF-8 bytes after trimming |
| `ignoreFilterConsistency` | No | boolean string: true or false |
| `page` | No | integer string; 1-1000 |

### Branded keyword share

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

Defaults to the previous complete UTC month. duration is fixed to 1m.

### Traffic geography

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

Defaults to the previous three complete UTC months, pageSize=5 and orderBy=TotalShare desc.

### Device distribution

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

Defaults to the previous three complete UTC months and ShouldGetVerifiedData=false.

### Search performance

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

Defaults to the previous complete UTC month, pageSize=5, duration=1m and SourceType=Organic. Use SourceType=Paid for paid keywords; do not substitute sourceType.

### Social traffic

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

Defaults to the previous three complete UTC months. webSource is not accepted.

### Engagement overview

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

Defaults include ShouldGetVerifiedData=false, includeLeaders=true and unBounced=false. Native Data rows may contain AvgMonthVisits, BounceRate, PagesPerVisit and AvgVisitDuration.

### Total visits

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

compareFrom and compareTo must be supplied together as valid ordered dates. timeGranularity is Monthly. Native fields may include TotalVisits, Change and ShareOfVisits; a rolling total is not necessarily a complete-calendar-month total.

### Visits table

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

compareFrom and compareTo must be supplied together as valid ordered dates. timeGranularity is Monthly; rows are in `Data`, with `Domain` and `TotalVisits`. `TotalCount` can be 0 even when `Data` contains rows; inspect the array itself to determine whether results are present.

### Visits trend

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

Defaults to the rolling 28-day daily window. timeGranularity accepts Daily, Weekly or Monthly.

### Website ranks

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

timeGranularity is Monthly. Native response uses distinct GlobalRank, CountryRank and CategoryRank objects.

### Country ranks

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

timeGranularity is Monthly. This is the explicit country-rank table, not the combined ranks response. Rows are in `Data`, with `Domain` and `Rank`. `TotalCount` can be 0 even when rows are present; inspect `Data` directly.

### Global ranks

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

timeGranularity is Monthly. This returns the separate global-rank table. Rows are in `Data`, with `Domain` and `Rank`. `TotalCount` can be 0 even when rows are present; inspect `Data` directly.

### Category ranks

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

timeGranularity is Monthly. This returns the separate industry/category-rank table. Rows are in `Data`, with `Domain` and `Rank`. `TotalCount` can be 0 even when rows are present; inspect `Data` directly.

### Traffic channels

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

Defaults to the rolling 28-day daily window. With `webSource=Total`, channel values are under `Data.Total[domain]`, not directly under `Data[domain]`. Channel names are preserved, for example `Search - Organic` and `Direct`. Values are visit counts; derive shares only when their sum is positive.

### Similar sites

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

Defaults to the previous three complete UTC months. isWindow must be false, timeGranularity is Monthly, and orderBy is fixed to Affinity desc. No latest or webSource.

### Similar site suggestions

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

Singular key; limit defaults to 20 and must be 1-20. country defaults to 999 and webSource to Total. The observed native response is an unwrapped array of candidates containing `Domain`, `DomainWithoutSub`, numeric `Rank`, and `Favicon`; do not expect a `Data` envelope. An empty array contains no suggestions. Only worldwide data is supported (`country=999`).

| Query field | Required | Type and constraints |
| --- | --- | --- |
| `key` | Yes | string; 1-2048 UTF-8 bytes after trimming |
| `limit` | No | integer string; 1-20 |
| `country` | No | nonnegative integer string; Only worldwide data is supported (`country=999`). Other valid country values are changed to `999` before the upstream request and return worldwide, not country-specific, data. |
| `webSource` | No | string; enum: Total, Desktop, MobileWeb |

### Monthly visits history

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

Defaults to the previous six complete UTC months. Only country=999, isWindow=false and timeGranularity=Monthly are supported. latest accepts 1m through 6m; explicit dates must be complete months inside that rolling six-month window. Native series may appear under Data.<domain>.<source> with Key/Value points; source names, including MobileWeb or Mobile Web, are preserved. Values represent estimated visits.

### Monthly bounce rate history

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

### Monthly visit duration history

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

### Monthly pages per visit history

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

Wszystkie poniższe ścieżki są względne wobec adresu źródłowego API. Każde żądanie wymaga Authorization: Bearer YOUR_API_KEY, używa GET i nie ma treści. Zobacz uwierzytelnianie, rozliczenia i błędy.

Reguły zapytań

Pola pojedynczej witryny key i Key wymagają jednej domeny ASCII, takiej jak amazon.com, do 253 znaków, bez otaczających białych znaków. Nie wysyłaj w tych polach adresu URL, IP, listy domen ani danych uwierzytelniających API. Dla domen międzynarodowych używaj punycode.

W nazwach zapytań wielkość liter ma znaczenie. Nieznane pola, duplikaty, CR/LF/NUL i nieprawidłowe wartości są odrzucane. Wartości logiczne to dosłowne true lub false; zero nie jest zamienne z false. Tekst ma 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków. Koduj spacje, tablice JSON i separatory mechanizmem kodowania zapytań klienta HTTP.

from i to muszą występować razem, być rzeczywistymi datami kalendarzowymi w formacie YYYY-MM-DD lub YYYY|MM|DD i spełniać from <= to. Para porównawcza podlega tej samej regule. Pola opcjonalne dziedziczą wartości domyślne punktu końcowego; tabele wymieniają pola dozwolone, a nie wymóg wysłania wszystkich.

Dla punktów końcowych przyjmujących daty pierwszeństwo ma poprawny, pełny jawny zakres from/to. W punktach przyjmujących latest podana wartość nadal musi przejść istniejącą walidację formatu i danego punktu końcowego, ale jest pomijana przy wyborze zakresu i nie jest wysyłana do Similarweb; nie dodaje się domyślnego latest. Bez jawnego zakresu istniejące zachowanie latest, wartości domyślnych i okna pozostaje bez zmian. Ograniczenia historii nadal obowiązują, a punkty nieprzyjmujące latest nadal je odrzucają.

Bez jawnego zakresu from/to: trasy okien czasowych domyślnie obejmują 28 dni kończących się trzy dni UTC temu i akceptują latest=1d do 366d. Trasy stałych miesięcy mają wartości domyślne podane poniżej. Zaangażowanie, wizyty, rankingi i kanały dodatkowo akceptują latest=1m|2m|3m|6m dla poprzednich pełnych miesięcy kalendarzowych UTC; selektory wymagają isWindow=false i domyślnie ustawiają timeGranularity=Monthly. Historia ma węższe reguły opisane dla jej czterech punktów końcowych.

Obsługiwane są tylko dane światowe (country=999). Identyfikatory witryn to domeny, takie jak example.com, z wyjątkiem rankingu słowa kluczowego, gdzie keys jest wyszukiwanym hasłem. Dostępność danych dostawcy, filtry i typy dopasowania mogą się różnić. Inne poprawne wartości kraju są zmieniane na 999 przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.

Udane odpowiedzi zachowują natywny JSON zamiast przyjmować uniwersalny schemat odpowiedzi. Tabele odesłań przychodzących i wychodzących używają Records; wskaźniki historyczne mogą używać zagnieżdżonego Data. Poniższe nazwy i jednostki nie oznaczają, że każde opcjonalne pole dostawcy jest zawsze obecne.

Punkty końcowe

Propozycje słów kluczowych

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

Domyślnie: country 999, latest 28d, rowsPerPage 100, type Broad, websource Total i windowVolume malejąco. Opcjonalne page zaczyna się od 1. rangeFilter używa natywnej składni, na przykład volume,100,10000|difficulty,0,40. Dostępność typów dopasowania i filtrów zależy od źródła danych. Obsługiwane są tylko dane światowe (country=999).

Pole zapytania	Wymagane	Typ i ograniczenia
`keyword`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`sort`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`asc`	Nie	ciąg wartości logicznej: true lub false
`page`	Nie	ciąg liczby całkowitej; 1-1000
`rowsPerPage`	Nie	ciąg liczby całkowitej; 1-1000
`type`	Nie	ciąg znaków; dozwolone wartości: Broad, Phrase, Exact, Related
`websource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`rangeFilter`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków

Linki zwrotne

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

Domyślnie: Page 1, PageSize 100, Status All, FollowType All i DomainScore malejąco. Key zaczyna się wielką literą; nie używaj key ani keys.

Pole zapytania	Wymagane	Typ i ograniczenia
`Key`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`Page`	Nie	ciąg liczby całkowitej; 1-1000
`PageSize`	Nie	ciąg liczby całkowitej; 1-1000
`Status`	Nie	ciąg znaków; dozwolone wartości: All, Active, New, Lost
`FollowType`	Nie	ciąg znaków; dozwolone wartości: All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow
`DomainScoreFrom`	Nie	ciąg liczby całkowitej; 0-100
`DomainScoreTo`	Nie	ciąg liczby całkowitej; 0-100
`sort`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`asc`	Nie	ciąg wartości logicznej: true lub false

Słowa kluczowe witryny

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

Domyślnie: page 1, pageSize 100, sourceType all i obie flagi marki false. pageFilterJson to jeden zakodowany w URL ciąg tablicy JSON; po pominięciu wskazuje keys jako domenę. Bez jawnego zakresu from/to: latest=1m wybiera jednomiesięczny tryb przeglądu z pageSize 5 i isWindow=false, chyba że podano je jawnie. Dla widoków słów niezwiązanych z marką użyj sourceType=organic lub paid z IncludeNoneBranded=true i IncludeBranded=false.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Daily, Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`sort`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`asc`	Nie	ciąg wartości logicznej: true lub false
`iso`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`isDaily`	Nie	ciąg wartości logicznej: true lub false
`IncludeBranded`	Nie	ciąg wartości logicznej: true lub false
`IncludeNoneBranded`	Nie	ciąg wartości logicznej: true lub false
`page`	Nie	ciąg liczby całkowitej; 1-1000
`pageSize`	Nie	ciąg liczby całkowitej; 1-1000
`sourceType`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`pageFilterJson`	Nie	ciąg znaków zawierający tablicę JSON

Witryny w rankingu słowa kluczowego

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

keys jest słowem kluczowym, a nie domeną witryny. Domyślne ustawienia obejmują selectedPageTab=Organic, sourceType=organic, Device=Total i graphDuration=28d. Opcjonalne page i pageSize używają liczb całkowitych od 1 lub dodatnich.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Daily, Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`sort`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`asc`	Nie	ciąg wartości logicznej: true lub false
`iso`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`isDaily`	Nie	ciąg wartości logicznej: true lub false
`tab`	Nie	ciąg nieujemnej liczby całkowitej
`mtd`	Nie	ciąg wartości logicznej: true lub false
`selectedPageTab`	Nie	ciąg znaków; dozwolone wartości: Organic, Paid
`graphDuration`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`graphType`	Nie	ciąg liczby całkowitej; 1-1000
`isDurationChanged`	Nie	ciąg wartości logicznej: true lub false
`ignoreFilterConsistency`	Nie	ciąg wartości logicznej: true lub false
`Device`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`sourceType`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`page`	Nie	ciąg liczby całkowitej; 1-1000
`pageSize`	Nie	ciąg liczby całkowitej; 1-1000

Źródła ruchu

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

Domyślnie: sourceType=Referral, page=1, orderBy=Share desc i timeGranularity=Daily. Ta tabela jest odrębna od punktu końcowego incoming-referrals.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Daily, Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`sourceType`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`ignoreFilterConsistency`	Nie	ciąg wartości logicznej: true lub false
`page`	Nie	ciąg liczby całkowitej; 1-1000
`orderBy`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków

Ruch wychodzący

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

from i to są wymagane. Tylko pojedyncze key. Domyślnie: country=999, isWWW=false, isWindow=false, webSource=Total, page=1, orderby=Share desc, orderBy=Share desc, sort=Share, asc=false. orderby i orderBy są odrębne i przekazywane niezależnie; zachowuj ich zgodność. Bez latest, pageSize, rowsPerPage, includeSubDomains ani timeGranularity. Wiersze znajdują się w Records; TotalCount jest sumą dostawcy, a nie długością bieżącej strony. Obsługiwane są tylko dane światowe (country=999).

Pole zapytania	Wymagane	Typ i ograniczenia
`key`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Tak	ciąg znaków; poprawna data w powyższych formatach
`to`	Tak	ciąg znaków; poprawna data w powyższych formatach
`isWWW`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`orderby`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`orderBy`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`sort`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`asc`	Nie	ciąg wartości logicznej: true lub false
`page`	Nie	ciąg liczby całkowitej; 1-1000

Odesłania przychodzące

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

Tylko pojedyncze key. Domyślnie: country=999, latest=28d, isWWW=false, isWindow=true, isDaily=false, webSource=Total, selectedTab=incomingTraffic, orderBy=TotalShare desc, ignoreFilterConsistency=false, page=1. Bez keys, pageSize, rowsPerPage, includeSubDomains ani timeGranularity. Wiersze znajdują się w Records; natywne pola mogą obejmować SiteOrigins i TotalShare. Obsługiwane są tylko dane światowe (country=999).

Pole zapytania	Wymagane	Typ i ograniczenia
`key`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`isWWW`	Nie	ciąg wartości logicznej: true lub false
`iso`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`isDaily`	Nie	ciąg wartości logicznej: true lub false
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`selectedTab`	Nie	ciąg znaków; dozwolone wartości: incomingTraffic
`orderBy`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`ignoreFilterConsistency`	Nie	ciąg wartości logicznej: true lub false
`page`	Nie	ciąg liczby całkowitej; 1-1000

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

Domyślnie poprzedni pełny miesiąc UTC. duration jest ustalone na 1m.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Daily, Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`duration`	Nie	ciąg znaków; dozwolone wartości: 1m

Geografia ruchu

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

Domyślnie poprzednie trzy pełne miesiące UTC, pageSize=5 i orderBy=TotalShare desc.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Daily, Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`pageSize`	Nie	ciąg liczby całkowitej; 1-1000
`orderBy`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków

Podział urządzeń

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

Domyślnie poprzednie trzy pełne miesiące UTC i ShouldGetVerifiedData=false.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Daily, Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`ShouldGetVerifiedData`	Nie	ciąg wartości logicznej: true lub false

Wyniki wyszukiwania

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

Domyślnie poprzedni pełny miesiąc UTC, pageSize=5, duration=1m i SourceType=Organic. Dla płatnych słów kluczowych użyj SourceType=Paid; nie zastępuj przez sourceType.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Daily, Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`pageSize`	Nie	ciąg liczby całkowitej; 1-1000
`duration`	Nie	ciąg znaków; dozwolone wartości: 1m
`SourceType`	Nie	ciąg znaków; dozwolone wartości: Organic, Paid

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

Domyślnie poprzednie trzy pełne miesiące UTC. webSource nie jest akceptowane.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Daily, Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków

Przegląd zaangażowania

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

Wartości domyślne obejmują ShouldGetVerifiedData=false, includeLeaders=true i unBounced=false. Natywne wiersze Data mogą zawierać AvgMonthVisits, BounceRate, PagesPerVisit i AvgVisitDuration.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Daily, Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`ShouldGetVerifiedData`	Nie	ciąg wartości logicznej: true lub false
`includeLeaders`	Nie	ciąg wartości logicznej: true lub false
`unBounced`	Nie	ciąg wartości logicznej: true lub false
`beta`	Nie	ciąg wartości logicznej: true lub false

Łączna liczba wizyt

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

compareFrom i compareTo muszą być podane razem jako poprawne daty we właściwej kolejności. timeGranularity wynosi Monthly. Natywne pola mogą obejmować TotalVisits, Change i ShareOfVisits; suma krocząca nie musi być sumą pełnego miesiąca kalendarzowego.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`compareFrom`	Nie	ciąg znaków; poprawna data w powyższych formatach
`compareTo`	Nie	ciąg znaków; poprawna data w powyższych formatach
`ShouldGetVerifiedData`	Nie	ciąg wartości logicznej: true lub false

Tabela wizyt

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

compareFrom i compareTo muszą być podane razem jako poprawne daty we właściwej kolejności. timeGranularity wynosi Monthly; wiersze są w Data, z Domain i TotalVisits. TotalCount może wynosić 0, nawet gdy Data zawiera wiersze; sprawdź samą tablicę, aby ustalić obecność wyników.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`compareFrom`	Nie	ciąg znaków; poprawna data w powyższych formatach
`compareTo`	Nie	ciąg znaków; poprawna data w powyższych formatach
`ShouldGetVerifiedData`	Nie	ciąg wartości logicznej: true lub false

Trend wizyt

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

Domyślnie kroczące dzienne okno 28 dni. timeGranularity akceptuje Daily, Weekly lub Monthly.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Daily, Weekly, Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`ShouldGetVerifiedData`	Nie	ciąg wartości logicznej: true lub false

Rankingi witryny

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

timeGranularity wynosi Monthly. Natywna odpowiedź używa odrębnych obiektów GlobalRank, CountryRank i CategoryRank.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków

Rankingi krajowe

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

timeGranularity wynosi Monthly. To osobna tabela rankingu krajowego, a nie połączona odpowiedź rankingów. Wiersze są w Data, z Domain i Rank. TotalCount może wynosić 0 nawet przy obecnych wierszach; sprawdź bezpośrednio Data.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków

Rankingi globalne

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

timeGranularity wynosi Monthly. Zwraca osobną tabelę rankingu globalnego. Wiersze są w Data, z Domain i Rank. TotalCount może wynosić 0 nawet przy obecnych wierszach; sprawdź bezpośrednio Data.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków

Rankingi kategorii

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

timeGranularity wynosi Monthly. Zwraca osobną tabelę rankingu branży lub kategorii. Wiersze są w Data, z Domain i Rank. TotalCount może wynosić 0 nawet przy obecnych wierszach; sprawdź bezpośrednio Data.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków

Kanały ruchu

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

Domyślnie kroczące dzienne okno 28 dni. Przy webSource=Total wartości kanałów znajdują się pod Data.Total[domain], a nie bezpośrednio pod Data[domain]. Nazwy kanałów są zachowane, na przykład Search - Organic i Direct. Wartości są liczbami wizyt; obliczaj udziały tylko wtedy, gdy suma jest dodatnia.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Daily, Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków

Podobne witryny

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

Domyślnie poprzednie trzy pełne miesiące UTC. isWindow musi wynosić false, timeGranularity to Monthly, a orderBy jest ustalone na Affinity desc. Bez latest i webSource.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Monthly
`orderBy`	Nie	ciąg znaków; dozwolone wartości: Affinity desc

Propozycje podobnych witryn

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

Pojedyncze key; limit domyślnie wynosi 20 i musi mieścić się w 1-20. country domyślnie wynosi 999, a webSource Total. Zaobserwowana natywna odpowiedź to nieopakowana tablica kandydatów zawierająca Domain, DomainWithoutSub, numeryczny Rank i Favicon; nie oczekuj opakowania Data. Pusta tablica nie zawiera propozycji. Obsługiwane są tylko dane światowe (country=999).

Pole zapytania	Wymagane	Typ i ograniczenia
`key`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`limit`	Nie	ciąg liczby całkowitej; 1-20
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb

Miesięczna historia wizyt

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

Domyślnie poprzednie sześć pełnych miesięcy UTC. Obsługiwane są tylko country=999, isWindow=false i timeGranularity=Monthly. latest akceptuje 1m do 6m; jawne daty muszą obejmować pełne miesiące w tym kroczącym oknie sześciomiesięcznym. Natywne szeregi mogą występować pod Data.<domain>.<source> z punktami Key/Value; nazwy źródeł, w tym MobileWeb lub Mobile Web, są zachowane. Wartości oznaczają szacowane wizyty.

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków

Miesięczna historia współczynnika odrzuceń

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

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków

Miesięczna historia czasu wizyty

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

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków

Miesięczna historia stron na wizytę

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

Pole zapytania	Wymagane	Typ i ograniczenia
`keys`	Tak	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków
`country`	Nie	ciąg nieujemnej liczby całkowitej; Obsługiwane są tylko dane światowe (`country=999`). Inne poprawne wartości kraju są zmieniane na `999` przed żądaniem do dostawcy i zwracają dane światowe, a nie dotyczące konkretnego kraju.
`from`	Nie	ciąg znaków; poprawna data w powyższych formatach
`to`	Nie	ciąg znaków; poprawna data w powyższych formatach
`includeSubDomains`	Nie	ciąg wartości logicznej: true lub false
`isWindow`	Nie	ciąg wartości logicznej: true lub false
`webSource`	Nie	ciąg znaków; dozwolone wartości: Total, Desktop, MobileWeb
`timeGranularity`	Nie	ciąg znaków; dozwolone wartości: Monthly
`latest`	Nie	ciąg znaków; 1-2048 bajtów UTF-8 po usunięciu skrajnych białych znaków