Référence des endpoints SimilarwebAPI | Documentation des 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`

Tous les chemins ci-dessous sont relatifs à l’origine de votre API. Chaque requête nécessite Authorization: Bearer YOUR_API_KEY, utilise GET et n’a pas de corps. Consultez authentification, facturation et erreurs.

Règles de requête

Les champs singuliers de site key et Key nécessitent un seul domaine ASCII tel que amazon.com, limité à 253 caractères, sans espaces autour. N’envoyez pas d’URL, d’adresse IP, de liste de domaines ni d’identifiant API dans ces champs. Utilisez punycode pour les domaines internationalisés.

Les noms des paramètres sont sensibles à la casse. Les champs inconnus ou dupliqués, CR/LF/NUL et valeurs invalides sont rejetés. Les booléens sont les littéraux true ou false ; zéro ne remplace pas false. Le texte compte 1-2048 octets UTF-8 après suppression des espaces périphériques. Encodez espaces, tableaux JSON et séparateurs avec l’encodeur de paramètres de votre client HTTP.

from et to doivent être fournis ensemble, être des dates calendaires réelles au format YYYY-MM-DD ou YYYY|MM|DD et respecter from <= to. Une paire de comparaison suit la même règle. Les champs optionnels héritent des valeurs par défaut de l’endpoint ; les tableaux listent les champs autorisés, pas une obligation de tous les envoyer.

Pour les endpoints acceptant des dates, un intervalle explicite from/to valide et complet est prioritaire. Si l’endpoint accepte latest, la valeur fournie doit toujours respecter les validations existantes du format et de l’endpoint, mais elle est ignorée pour choisir l’intervalle et n’est pas envoyée à Similarweb ; aucune valeur latest par défaut n’est ajoutée. Sans intervalle explicite, les règles existantes de latest, des valeurs par défaut et des fenêtres restent inchangées. Les restrictions History restent applicables ; les endpoints qui n’acceptent pas latest continuent de le rejeter.

Sans intervalle explicite from/to : Les routes par fenêtre utilisent normalement 28 jours se terminant trois jours UTC auparavant et acceptent de latest=1d à 366d. Les routes par mois fixes ont les valeurs indiquées ci-dessous. Engagement, visites, classements et canaux acceptent aussi latest=1m|2m|3m|6m pour les mois calendaires UTC complets précédents ; ces sélecteurs nécessitent isWindow=false et utilisent timeGranularity=Monthly par défaut. L’historique suit des règles plus strictes décrites pour ses quatre endpoints.

Seules les données mondiales sont prises en charge (country=999). Les identifiants de sites sont des domaines comme example.com, sauf pour le classement par mot-clé où keys est un mot-clé de recherche. Disponibilité des données, filtres et types de correspondance peuvent varier selon le fournisseur. Les autres valeurs de pays valides sont remplacées par 999 avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.

Les réponses réussies conservent le JSON natif plutôt qu’un schéma universel. Les tableaux de sites référents entrants et sortants utilisent Records ; les métriques historiques peuvent utiliser Data imbriqué. Les noms et unités ci-dessous n’impliquent pas que chaque champ facultatif fournisseur soit toujours présent.

Points de terminaison

Suggestions de mots-clés

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

Valeurs par défaut : country 999, latest 28d, rowsPerPage 100, type Broad, websource Total et windowVolume décroissant. Le paramètre optionnel page commence à 1. rangeFilter utilise une syntaxe native, par exemple volume,100,10000|difficulty,0,40. La disponibilité des types de correspondance et filtres dépend de la source. Seules les données mondiales sont prises en charge (country=999).

Champ de requête	Obligatoire	Type et contraintes
`keyword`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`sort`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`asc`	Non	chaîne booléenne : true ou false
`page`	Non	chaîne d’entier ; 1-1000
`rowsPerPage`	Non	chaîne d’entier ; 1-1000
`type`	Non	chaîne ; énumération : Broad, Phrase, Exact, Related
`websource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`isWindow`	Non	chaîne booléenne : true ou false
`rangeFilter`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques

Liens entrants

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

Valeurs par défaut : Page 1, PageSize 100, Status All, FollowType All et DomainScore décroissant. Key commence par une majuscule ; n’utilisez pas key ou keys.

Champ de requête	Obligatoire	Type et contraintes
`Key`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`Page`	Non	chaîne d’entier ; 1-1000
`PageSize`	Non	chaîne d’entier ; 1-1000
`Status`	Non	chaîne ; énumération : All, Active, New, Lost
`FollowType`	Non	chaîne ; énumération : All, DoFollowOnly, NoFollowOnly, DoFollow, NoFollow
`DomainScoreFrom`	Non	chaîne d’entier ; 0-100
`DomainScoreTo`	Non	chaîne d’entier ; 0-100
`sort`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`asc`	Non	chaîne booléenne : true ou false

Mots-clés d’un site

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

Valeurs par défaut : page 1, pageSize 100, sourceType all et les deux indicateurs de marque false. pageFilterJson est une seule chaîne de tableau JSON encodée en URL ; lorsqu’il est omis, il cible keys comme domaine. Sans intervalle explicite from/to : latest=1m sélectionne le résumé d’un mois avec pageSize 5 et isWindow=false sauf valeurs explicites. Utilisez sourceType=organic ou paid avec IncludeNoneBranded=true et IncludeBranded=false pour les vues de mots-clés hors marque.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Daily, Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`sort`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`asc`	Non	chaîne booléenne : true ou false
`iso`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`isDaily`	Non	chaîne booléenne : true ou false
`IncludeBranded`	Non	chaîne booléenne : true ou false
`IncludeNoneBranded`	Non	chaîne booléenne : true ou false
`page`	Non	chaîne d’entier ; 1-1000
`pageSize`	Non	chaîne d’entier ; 1-1000
`sourceType`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`pageFilterJson`	Non	chaîne contenant un tableau JSON

Sites classés pour un mot-clé

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

keys est un mot-clé, pas un domaine. Les valeurs par défaut comprennent selectedPageTab=Organic, sourceType=organic, Device=Total et graphDuration=28d. Les paramètres optionnels page et pageSize utilisent des entiers à partir de 1 ou positifs.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Daily, Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`sort`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`asc`	Non	chaîne booléenne : true ou false
`iso`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`isDaily`	Non	chaîne booléenne : true ou false
`tab`	Non	chaîne d’entier non négatif
`mtd`	Non	chaîne booléenne : true ou false
`selectedPageTab`	Non	chaîne ; énumération : Organic, Paid
`graphDuration`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`graphType`	Non	chaîne d’entier ; 1-1000
`isDurationChanged`	Non	chaîne booléenne : true ou false
`ignoreFilterConsistency`	Non	chaîne booléenne : true ou false
`Device`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`sourceType`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`page`	Non	chaîne d’entier ; 1-1000
`pageSize`	Non	chaîne d’entier ; 1-1000

Sources de trafic

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

Valeurs par défaut : sourceType=Referral, page=1, orderBy=Share desc et timeGranularity=Daily. Ce tableau est distinct de l’endpoint incoming-referrals.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Daily, Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`sourceType`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`ignoreFilterConsistency`	Non	chaîne booléenne : true ou false
`page`	Non	chaîne d’entier ; 1-1000
`orderBy`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques

Trafic sortant

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

from et to sont obligatoires. Uniquement key au singulier. Valeurs par défaut : country=999, isWWW=false, isWindow=false, webSource=Total, page=1, orderby=Share desc, orderBy=Share desc, sort=Share, asc=false. orderby et orderBy sont distincts et transmis séparément ; gardez-les cohérents. Aucun latest, pageSize, rowsPerPage, includeSubDomains ou timeGranularity. Les lignes sont dans Records ; TotalCount est le total fournisseur, pas la longueur de la page actuelle. Seules les données mondiales sont prises en charge (country=999).

Champ de requête	Obligatoire	Type et contraintes
`key`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Oui	chaîne ; date valide aux formats ci-dessus
`to`	Oui	chaîne ; date valide aux formats ci-dessus
`isWWW`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`orderby`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`orderBy`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`sort`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`asc`	Non	chaîne booléenne : true ou false
`page`	Non	chaîne d’entier ; 1-1000

Sites référents entrants

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

Uniquement key au singulier. Valeurs par défaut : country=999, latest=28d, isWWW=false, isWindow=true, isDaily=false, webSource=Total, selectedTab=incomingTraffic, orderBy=TotalShare desc, ignoreFilterConsistency=false, page=1. Aucun keys, pageSize, rowsPerPage, includeSubDomains ou timeGranularity. Les lignes sont dans Records ; les champs natifs peuvent inclure SiteOrigins et TotalShare. Seules les données mondiales sont prises en charge (country=999).

Champ de requête	Obligatoire	Type et contraintes
`key`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`isWWW`	Non	chaîne booléenne : true ou false
`iso`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`isWindow`	Non	chaîne booléenne : true ou false
`isDaily`	Non	chaîne booléenne : true ou false
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`selectedTab`	Non	chaîne ; énumération : incomingTraffic
`orderBy`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`ignoreFilterConsistency`	Non	chaîne booléenne : true ou false
`page`	Non	chaîne d’entier ; 1-1000

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

Par défaut, le mois calendaire UTC complet précédent. duration est fixé à 1m.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Daily, Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`duration`	Non	chaîne ; énumération : 1m

Répartition géographique du trafic

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

Par défaut, les trois mois calendaires UTC complets précédents, pageSize=5 et orderBy=TotalShare desc.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Daily, Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`pageSize`	Non	chaîne d’entier ; 1-1000
`orderBy`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques

Répartition des appareils

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

Par défaut, les trois mois calendaires UTC complets précédents et ShouldGetVerifiedData=false.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Daily, Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`ShouldGetVerifiedData`	Non	chaîne booléenne : true ou false

Performances de recherche

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

Par défaut, le mois calendaire UTC complet précédent, pageSize=5, duration=1m et SourceType=Organic. Utilisez SourceType=Paid pour les mots-clés payants ; ne le remplacez pas par sourceType.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Daily, Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`pageSize`	Non	chaîne d’entier ; 1-1000
`duration`	Non	chaîne ; énumération : 1m
`SourceType`	Non	chaîne ; énumération : Organic, Paid

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

Par défaut, les trois mois calendaires UTC complets précédents. webSource n’est pas accepté.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`timeGranularity`	Non	chaîne ; énumération : Daily, Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques

Vue d’ensemble de l’engagement

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

Les valeurs par défaut comprennent ShouldGetVerifiedData=false, includeLeaders=true et unBounced=false. Les lignes natives de Data peuvent contenir AvgMonthVisits, BounceRate, PagesPerVisit et AvgVisitDuration.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Daily, Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`ShouldGetVerifiedData`	Non	chaîne booléenne : true ou false
`includeLeaders`	Non	chaîne booléenne : true ou false
`unBounced`	Non	chaîne booléenne : true ou false
`beta`	Non	chaîne booléenne : true ou false

Visites totales

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

compareFrom et compareTo doivent être fournis ensemble comme dates valides et ordonnées. timeGranularity est Monthly. Les champs natifs peuvent inclure TotalVisits, Change et ShareOfVisits ; un total glissant n’est pas nécessairement un total de mois calendaire complet.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`compareFrom`	Non	chaîne ; date valide aux formats ci-dessus
`compareTo`	Non	chaîne ; date valide aux formats ci-dessus
`ShouldGetVerifiedData`	Non	chaîne booléenne : true ou false

Tableau des visites

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

compareFrom et compareTo doivent être fournis ensemble comme dates valides et ordonnées. timeGranularity est Monthly ; les lignes sont dans Data, avec Domain et TotalVisits. TotalCount peut valoir 0 même si Data contient des lignes ; examinez le tableau lui-même pour déterminer la présence de résultats.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`compareFrom`	Non	chaîne ; date valide aux formats ci-dessus
`compareTo`	Non	chaîne ; date valide aux formats ci-dessus
`ShouldGetVerifiedData`	Non	chaîne booléenne : true ou false

Évolution des visites

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

Par défaut, une fenêtre glissante quotidienne de 28 jours. timeGranularity accepte Daily, Weekly ou Monthly.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Daily, Weekly, Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`ShouldGetVerifiedData`	Non	chaîne booléenne : true ou false

Classements du site

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

timeGranularity est Monthly. La réponse native utilise des objets distincts GlobalRank, CountryRank et CategoryRank.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques

Classements par pays

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

timeGranularity est Monthly. Il s’agit du tableau explicite de classement par pays, pas de la réponse combinée. Les lignes sont dans Data, avec Domain et Rank. TotalCount peut valoir 0 même avec des lignes ; examinez directement Data.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques

Classements mondiaux

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

timeGranularity est Monthly. Renvoie le tableau distinct de classement mondial. Les lignes sont dans Data, avec Domain et Rank. TotalCount peut valoir 0 même avec des lignes ; examinez directement Data.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques

Classements par catégorie

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

timeGranularity est Monthly. Renvoie le tableau distinct de classement par secteur/catégorie. Les lignes sont dans Data, avec Domain et Rank. TotalCount peut valoir 0 même avec des lignes ; examinez directement Data.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques

Canaux de trafic

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

Par défaut, une fenêtre glissante quotidienne de 28 jours. Avec webSource=Total, les valeurs des canaux sont sous Data.Total[domain], pas directement sous Data[domain]. Les noms de canaux sont conservés, par exemple Search - Organic et Direct. Les valeurs sont des nombres de visites ; calculez les parts uniquement si leur somme est positive.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Daily, Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques

Sites similaires

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

Par défaut, les trois mois calendaires UTC complets précédents. isWindow doit être false, timeGranularity est Monthly et orderBy est fixé à Affinity desc. Aucun latest ou webSource.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`timeGranularity`	Non	chaîne ; énumération : Monthly
`orderBy`	Non	chaîne ; énumération : Affinity desc

Suggestions de sites similaires

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

key au singulier ; limit vaut 20 par défaut et doit être entre 1 et 20. country vaut 999 par défaut et webSource Total. La réponse native observée est un tableau non enveloppé de candidats contenant Domain, DomainWithoutSub, Rank numérique et Favicon ; n’attendez pas d’enveloppe Data. Un tableau vide ne contient aucune suggestion. Seules les données mondiales sont prises en charge (country=999).

Champ de requête	Obligatoire	Type et contraintes
`key`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`limit`	Non	chaîne d’entier ; 1-20
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb

Historique des visites mensuelles

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

Par défaut, les six mois calendaires UTC complets précédents. Seuls country=999, isWindow=false et timeGranularity=Monthly sont pris en charge. latest accepte de 1m à 6m ; les dates explicites doivent couvrir des mois complets dans cette fenêtre glissante de six mois. Les séries natives peuvent apparaître sous Data.<domain>.<source> avec des points Key/Value ; les noms de sources, dont MobileWeb ou Mobile Web, sont conservés. Les valeurs représentent des visites estimées.

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques

Historique mensuel du taux de rebond

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

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques

Historique mensuel de durée des visites

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

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques

Historique mensuel des pages par visite

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

Champ de requête	Obligatoire	Type et contraintes
`keys`	Oui	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques
`country`	Non	chaîne d’entier non négatif; Seules les données mondiales sont prises en charge (`country=999`). Les autres valeurs de pays valides sont remplacées par `999` avant la requête au fournisseur ; les données renvoyées sont mondiales, et non celles du pays indiqué.
`from`	Non	chaîne ; date valide aux formats ci-dessus
`to`	Non	chaîne ; date valide aux formats ci-dessus
`includeSubDomains`	Non	chaîne booléenne : true ou false
`isWindow`	Non	chaîne booléenne : true ou false
`webSource`	Non	chaîne ; énumération : Total, Desktop, MobileWeb
`timeGranularity`	Non	chaîne ; énumération : Monthly
`latest`	Non	chaîne ; 1-2048 octets UTF-8 après suppression des espaces périphériques