Справочник API Similarweb | Документация 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`

Все пути ниже указаны относительно адреса вашего API. Каждый запрос требует Authorization: Bearer YOUR_API_KEY, использует GET и не содержит тела. См. аутентификацию, оплату и ошибки.

Правила запросов

Поля одного сайта key и Key требуют один ASCII-домен, например amazon.com, длиной не более 253 символов без пробелов по краям. Не передавайте в этих полях URL, IP-адрес, список доменов или учётные данные API. Для интернационализированных доменов используйте punycode.

Имена параметров чувствительны к регистру. Неизвестные и повторяющиеся поля, CR/LF/NUL и недопустимые значения отклоняются. Логические значения — литералы true или false; ноль не заменяет false. Текст после удаления пробелов по краям должен занимать 1-2048 байт UTF-8. Кодируйте пробелы, массивы JSON и разделители с помощью кодировщика параметров вашего HTTP-клиента.

from и to должны присутствовать вместе, быть реальными календарными датами в формате YYYY-MM-DD или YYYY|MM|DD и удовлетворять условию from <= to. Для пары сравнения действует то же правило. Необязательные поля наследуют значения по умолчанию конечной точки; таблицы перечисляют допустимые поля, но не требуют отправлять их все.

Для конечных точек, принимающих даты, допустимый полный явно заданный диапазон from/to имеет приоритет. Если конечная точка принимает latest, заданное значение по-прежнему проходит существующие проверки формата и допустимых значений, но не используется для выбора диапазона и не отправляется в Similarweb; значение latest по умолчанию не добавляется. Без явного диапазона прежние правила latest, значений по умолчанию и окон сохраняются. Ограничения History остаются в силе; конечные точки без поддержки latest по-прежнему отклоняют это поле.

Без явно заданного диапазона from/to: Маршруты с временным окном обычно используют 28 дней, заканчивающихся три дня UTC назад, и принимают от latest=1d до 366d. Значения по умолчанию для маршрутов с фиксированными месяцами приведены ниже. Вовлечённость, посещения, рейтинги и каналы также принимают latest=1m|2m|3m|6m для предыдущих полных календарных месяцев UTC; эти селекторы требуют isWindow=false и по умолчанию используют timeGranularity=Monthly. Для истории действуют более узкие правила, описанные для её четырёх конечных точек.

Поддерживаются только данные по всему миру (country=999). Идентификаторы сайтов — домены, например example.com, кроме конечной точки рейтинга по ключевому слову, где keys — поисковое ключевое слово. Доступность данных, фильтры и типы соответствия вышестоящего источника могут различаться. Другие допустимые значения страны заменяются на 999 перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.

Успешные ответы сохраняют исходный JSON, не приводя его к универсальной схеме. Таблицы входящих и исходящих переходов используют Records; исторические показатели могут использовать вложенные Data. Указанные ниже имена и единицы не означают, что каждое необязательное поле вышестоящего источника всегда присутствует.

Конечные точки

Предложения ключевых слов

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

Значения по умолчанию: country 999, latest 28d, rowsPerPage 100, type Broad, websource Total и windowVolume по убыванию. Необязательный page начинается с 1. rangeFilter использует исходный синтаксис, например volume,100,10000|difficulty,0,40. Доступность типов соответствия и фильтров зависит от источника данных. Поддерживаются только данные по всему миру (country=999).

Поле запроса	Обязательно	Тип и ограничения
`keyword`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`sort`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`asc`	Нет	Логическая строка: true или false
`page`	Нет	Строка с целым числом; 1-1000
`rowsPerPage`	Нет	Строка с целым числом; 1-1000
`type`	Нет	Строка; допустимые значения: Broad, Phrase, Exact, Related
`websource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`isWindow`	Нет	Логическая строка: true или false
`rangeFilter`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям

Обратные ссылки

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

Значения по умолчанию: Page 1, PageSize 100, Status All, FollowType All и DomainScore по убыванию. Key начинается с заглавной буквы; не используйте key или keys.

Поле запроса	Обязательно	Тип и ограничения
`Key`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`Page`	Нет	Строка с целым числом; 1-1000
`PageSize`	Нет	Строка с целым числом; 1-1000
`Status`	Нет	Строка; допустимые значения: All, Active, New, Lost
`FollowType`	Нет	Строка; допустимые значения: All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow
`DomainScoreFrom`	Нет	Строка с целым числом; 0-100
`DomainScoreTo`	Нет	Строка с целым числом; 0-100
`sort`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`asc`	Нет	Логическая строка: true или false

Ключевые слова сайта

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

Значения по умолчанию: page 1, pageSize 100, sourceType all и оба брендовых флага false. pageFilterJson — одна строка массива JSON с URL-кодированием; при отсутствии этого поля keys используется как домен. Без явно заданного диапазона from/to: latest=1m выбирает режим обзора за один месяц с pageSize 5 и isWindow=false, если явно не задано иное. Для просмотра небрендовых ключевых слов используйте sourceType=organic или paid вместе с IncludeNoneBranded=true и IncludeBranded=false.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Daily, Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`sort`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`asc`	Нет	Логическая строка: true или false
`iso`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`isDaily`	Нет	Логическая строка: true или false
`IncludeBranded`	Нет	Логическая строка: true или false
`IncludeNoneBranded`	Нет	Логическая строка: true или false
`page`	Нет	Строка с целым числом; 1-1000
`pageSize`	Нет	Строка с целым числом; 1-1000
`sourceType`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`pageFilterJson`	Нет	Строка, содержащая массив JSON

Сайты в рейтинге по ключевому слову

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

keys — ключевое слово, а не домен сайта. Значения по умолчанию включают selectedPageTab=Organic, sourceType=organic, Device=Total и graphDuration=28d. Необязательные page и pageSize используют соответственно целые числа начиная с 1 и положительные целые числа.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Daily, Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`sort`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`asc`	Нет	Логическая строка: true или false
`iso`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`isDaily`	Нет	Логическая строка: true или false
`tab`	Нет	Строка с неотрицательным целым числом
`mtd`	Нет	Логическая строка: true или false
`selectedPageTab`	Нет	Строка; допустимые значения: Organic, Paid
`graphDuration`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`graphType`	Нет	Строка с целым числом; 1-1000
`isDurationChanged`	Нет	Логическая строка: true или false
`ignoreFilterConsistency`	Нет	Логическая строка: true или false
`Device`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`sourceType`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`page`	Нет	Строка с целым числом; 1-1000
`pageSize`	Нет	Строка с целым числом; 1-1000

Источники трафика

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

Значения по умолчанию: sourceType=Referral, page=1, orderBy=Share desc и timeGranularity=Daily. Эта таблица отличается от конечной точки входящих переходов.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Daily, Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`sourceType`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`ignoreFilterConsistency`	Нет	Логическая строка: true или false
`page`	Нет	Строка с целым числом; 1-1000
`orderBy`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям

Исходящий трафик

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

from и to обязательны. Только одиночный key. Значения по умолчанию: country=999, isWWW=false, isWindow=false, webSource=Total, page=1, orderby=Share desc, orderBy=Share desc, sort=Share, asc=false. orderby и orderBy — разные поля, передаваемые независимо; поддерживайте их согласованность. latest, pageSize, rowsPerPage, includeSubDomains и timeGranularity не принимаются. Строки находятся в Records; TotalCount — общее число у вышестоящего источника, а не длина текущей страницы. Поддерживаются только данные по всему миру (country=999).

Поле запроса	Обязательно	Тип и ограничения
`key`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Да	Строка; допустимая дата в указанных выше форматах
`to`	Да	Строка; допустимая дата в указанных выше форматах
`isWWW`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`orderby`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`orderBy`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`sort`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`asc`	Нет	Логическая строка: true или false
`page`	Нет	Строка с целым числом; 1-1000

Входящие переходы

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

Только одиночный key. Значения по умолчанию: country=999, latest=28d, isWWW=false, isWindow=true, isDaily=false, webSource=Total, selectedTab=incomingTraffic, orderBy=TotalShare desc, ignoreFilterConsistency=false, page=1. keys, pageSize, rowsPerPage, includeSubDomains и timeGranularity не принимаются. Строки находятся в Records; исходные поля могут включать SiteOrigins и TotalShare. Поддерживаются только данные по всему миру (country=999).

Поле запроса	Обязательно	Тип и ограничения
`key`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`isWWW`	Нет	Логическая строка: true или false
`iso`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`isWindow`	Нет	Логическая строка: true или false
`isDaily`	Нет	Логическая строка: true или false
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`selectedTab`	Нет	Строка; допустимые значения: incomingTraffic
`orderBy`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`ignoreFilterConsistency`	Нет	Логическая строка: true или false
`page`	Нет	Строка с целым числом; 1-1000

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

По умолчанию используется предыдущий полный месяц UTC. duration фиксирован на 1m.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Daily, Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`duration`	Нет	Строка; допустимые значения: 1m

География трафика

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

По умолчанию используются три предыдущих полных месяца UTC, pageSize=5 и orderBy=TotalShare desc.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Daily, Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`pageSize`	Нет	Строка с целым числом; 1-1000
`orderBy`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям

Распределение по устройствам

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

По умолчанию используются три предыдущих полных месяца UTC и ShouldGetVerifiedData=false.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Daily, Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`ShouldGetVerifiedData`	Нет	Логическая строка: true или false

Эффективность поиска

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

По умолчанию используются предыдущий полный месяц UTC, pageSize=5, duration=1m и SourceType=Organic. Для платных ключевых слов используйте SourceType=Paid; не заменяйте его на sourceType.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Daily, Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`pageSize`	Нет	Строка с целым числом; 1-1000
`duration`	Нет	Строка; допустимые значения: 1m
`SourceType`	Нет	Строка; допустимые значения: Organic, Paid

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

По умолчанию используются три предыдущих полных месяца UTC. webSource не принимается.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`timeGranularity`	Нет	Строка; допустимые значения: Daily, Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям

Обзор вовлечённости

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

Значения по умолчанию включают ShouldGetVerifiedData=false, includeLeaders=true и unBounced=false. Исходные строки Data могут содержать AvgMonthVisits, BounceRate, PagesPerVisit и AvgVisitDuration.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Daily, Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`ShouldGetVerifiedData`	Нет	Логическая строка: true или false
`includeLeaders`	Нет	Логическая строка: true или false
`unBounced`	Нет	Логическая строка: true или false
`beta`	Нет	Логическая строка: true или false

Всего посещений

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

compareFrom и compareTo необходимо передавать вместе как допустимые упорядоченные даты. timeGranularity имеет значение Monthly. Исходные поля могут включать TotalVisits, Change и ShareOfVisits; скользящая сумма не обязательно равна сумме за полный календарный месяц.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`compareFrom`	Нет	Строка; допустимая дата в указанных выше форматах
`compareTo`	Нет	Строка; допустимая дата в указанных выше форматах
`ShouldGetVerifiedData`	Нет	Логическая строка: true или false

Таблица посещений

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

compareFrom и compareTo необходимо передавать вместе как допустимые упорядоченные даты. timeGranularity имеет значение Monthly; строки находятся в Data с Domain и TotalVisits. TotalCount может быть 0, даже если Data содержит строки; проверяйте сам массив, чтобы определить наличие результатов.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`compareFrom`	Нет	Строка; допустимая дата в указанных выше форматах
`compareTo`	Нет	Строка; допустимая дата в указанных выше форматах
`ShouldGetVerifiedData`	Нет	Логическая строка: true или false

Динамика посещений

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

По умолчанию используется скользящее 28-дневное окно с дневными данными. timeGranularity принимает Daily, Weekly или Monthly.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Daily, Weekly, Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`ShouldGetVerifiedData`	Нет	Логическая строка: true или false

Рейтинги сайтов

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

timeGranularity имеет значение Monthly. Исходный ответ использует отдельные объекты GlobalRank, CountryRank и CategoryRank.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям

Рейтинги по странам

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

timeGranularity имеет значение Monthly. Это явная таблица рейтинга по стране, а не объединённый ответ с рейтингами. Строки находятся в Data с Domain и Rank. TotalCount может быть 0 даже при наличии строк; проверяйте Data напрямую.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям

Глобальные рейтинги

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

timeGranularity имеет значение Monthly. Возвращается отдельная таблица глобального рейтинга. Строки находятся в Data с Domain и Rank. TotalCount может быть 0 даже при наличии строк; проверяйте Data напрямую.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям

Рейтинги по категориям

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

timeGranularity имеет значение Monthly. Возвращается отдельная таблица рейтинга по отрасли/категории. Строки находятся в Data с Domain и Rank. TotalCount может быть 0 даже при наличии строк; проверяйте Data напрямую.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям

Каналы трафика

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

По умолчанию используется скользящее 28-дневное окно с дневными данными. При webSource=Total значения каналов находятся в Data.Total[domain], а не непосредственно в Data[domain]. Названия каналов сохраняются, например Search - Organic и Direct. Значения — количество посещений; вычисляйте доли только при положительной сумме.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Daily, Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям

Предложения похожих сайтов

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

Одиночный key; limit по умолчанию равен 20 и должен быть в диапазоне 1-20. country по умолчанию равен 999, а webSource — Total. Наблюдаемый исходный ответ — массив кандидатов без обёртки, содержащий Domain, DomainWithoutSub, числовой Rank и Favicon; не ожидайте обёртку Data. Пустой массив не содержит предложений. Поддерживаются только данные по всему миру (country=999).

Поле запроса	Обязательно	Тип и ограничения
`key`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`limit`	Нет	Строка с целым числом; 1-20
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb

История месячных посещений

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

По умолчанию используются шесть предыдущих полных месяцев UTC. Поддерживаются только country=999, isWindow=false и timeGranularity=Monthly. latest принимает значения от 1m до 6m; явно заданные даты должны охватывать полные месяцы внутри этого скользящего шестимесячного окна. Исходные ряды могут находиться в Data.<domain>.<source> с точками Key/Value; названия источников, включая MobileWeb или Mobile Web, сохраняются. Значения представляют оценочное число посещений.

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям

История месячного показателя отказов

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

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям

История месячной длительности посещений

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

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям

История месячного числа страниц за посещение

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

Поле запроса	Обязательно	Тип и ограничения
`keys`	Да	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям
`country`	Нет	Строка с неотрицательным целым числом; Поддерживаются только данные по всему миру (`country=999`). Другие допустимые значения страны заменяются на `999` перед запросом к поставщику; возвращаются мировые данные, а не данные указанной страны.
`from`	Нет	Строка; допустимая дата в указанных выше форматах
`to`	Нет	Строка; допустимая дата в указанных выше форматах
`includeSubDomains`	Нет	Логическая строка: true или false
`isWindow`	Нет	Логическая строка: true или false
`webSource`	Нет	Строка; допустимые значения: Total, Desktop, MobileWeb
`timeGranularity`	Нет	Строка; допустимые значения: Monthly
`latest`	Нет	Строка; 1-2048 байт UTF-8 после удаления пробелов по краям