SimilarwebAPI エンドポイントリファレンス | 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 には、amazon.com のような ASCII ドメインを 1 つ指定してください。長さは最大 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 範囲がない場合：期間ウィンドウ型のルートは、通常、UTC で 3 日前を終了日とする 28 日間を既定とし、latest=1d から 366d を受け付けます。固定月のルートは、以下に記載する既定値を使用します。エンゲージメント、訪問数、ランキング、チャネルは、過去の完全な UTC 暦月を指定する latest=1m|2m|3m|6m にも対応しています。これらの指定には isWindow=false が必要で、既定値は timeGranularity=Monthly です。履歴には、4 つのエンドポイントに記載された、より限定的な規則が適用されます。

全世界のデータ（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 は URL エンコードした 1 つの JSON 配列文字列です。省略すると keys をドメインとして対象にします。明示的な from/to 範囲がない場合：latest=1m は 1 か月の概要モードを選択し、明示的に指定しない場合は 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 は 1 始まり、pageSize は正の整数です。

クエリフィールド	必須	型と制約
`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 です。この表は incoming-referrals エンドポイントとは別のものです。

クエリフィールド	必須	型と制約
`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

既定では、過去 3 か月の完全な 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

既定では、過去 3 か月の完全な 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

既定では、過去 3 か月の完全な 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 を含みます。Data に行が含まれていても TotalCount が 0 になる場合があるため、結果の有無は配列そのものを確認して判断してください。

クエリフィールド	必須	型と制約
`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[domain] の直下ではなく Data.Total[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

既定では、過去 3 か月の完全な UTC 暦月を使用します。isWindow は false にする必要があり、timeGranularity は Monthly、orderBy は Affinity desc に固定されています。latest と webSource は使用できません。

クエリフィールド	必須	型と制約
`keys`	はい	文字列。前後の空白を除去した後で 1-2048 UTF-8 バイト
`country`	いいえ	非負整数の文字列; 全世界のデータ（`country=999`）のみ対応しています。その他の有効な国パラメータ値は上流へのリクエスト前に `999` に変更され、指定国ではなく全世界のデータが返されます。
`from`	いいえ	文字列。上記の形式を使用した有効な日付
`to`	いいえ	文字列。上記の形式を使用した有効な日付
`includeSubDomains`	いいえ	真偽値の文字列：true または false
`isWindow`	いいえ	真偽値の文字列：true または false
`timeGranularity`	いいえ	文字列。列挙値： Monthly
`orderBy`	いいえ	文字列。列挙値： Affinity desc

類似サイトの候補

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

既定では、過去 6 か月の完全な UTC 暦月を使用します。country=999、isWindow=false、timeGranularity=Monthly のみに対応しています。latest は 1m から 6m を受け付けます。明示的な日付は、この移動 6 か月ウィンドウ内の完全な月を指定する必要があります。ネイティブの時系列は、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 バイト

月次の 1 訪問あたりページ数の履歴

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 バイト