API Hop

ドキュメント

API Hop ドキュメント

SimilarwebAPI

認証付きの REST エンドポイントで、ウェブサイトのトラフィック、検索キーワード、被リンク、参照元、競合、エンゲージメントを照会します。

SimilarwebAPI は /v1/similarweb 配下に 27 の読み取り専用データエンドポイントを提供します。他の RequestBeam API と同じアカウント、API キー、残高、使用履歴を利用できます。利用可否は、有効なゲートウェイと API キーの権限によって異なります。ドキュメントへの掲載は、本番環境での利用可否を確認するものではありません。

認証

サードパーティーの認証情報ではなく、自分の RequestBeam API キーを送信してください。

http
Authorization: Bearer YOUR_API_KEY

リクエスト例

すべての公開操作は、クエリパラメータ付きの GET を使用し、リクエストボディはありません。パスとパラメータの大文字・小文字は、ドキュメントに記載されたとおりにしてください。

全世界のデータ（country=999）のみ対応しています。 その他の有効な国パラメータ値は上流へのリクエスト前に 999 に変更され、指定国ではなく全世界のデータが返されます。

日付を受け付けるエンドポイントでは、有効で完全な明示的 from/to 範囲が優先されます。latest を受け付けるエンドポイントでは、指定値に既存の形式とエンドポイント固有の検証を適用しますが、範囲選択には使用せず、Similarweb にも送信しません。既定の latest も追加しません。明示的な範囲がなければ、既存の latest、既定値、ウィンドウの動作は変わりません。History の制限は引き続き適用され、latest を受け付けないエンドポイントでは引き続き拒否されます。

bash
curl --get "https://api.apihop.ai/v1/similarweb/websites/incoming-referrals" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "key=example.com" \
  --data-urlencode "country=999" \
  --data-urlencode "page=1"

流入参照元では、keys ではなく、小文字の key に単一のホスト名を指定します。この key は対象ウェブサイトの業務クエリパラメータであり、API 認証情報ではありません。明示的に許可された Similarweb の GET ルートでのみ使用できます。API 認証には引き続き Authorization を使用し、その他の認証情報クエリフィールドは禁止されています。行データは Data ではなく Records に返されます。操作ごとの正確なフィールドについては、全エンドポイントのリファレンスを参照してください。

対象範囲

  • 検索：キーワード候補、ランキングページ、ウェブサイトのキーワード、オーガニック検索・有料検索、ブランドキーワード。
  • ウェブサイトのトラフィック：エンゲージメント、訪問数、地域、デバイス構成、チャネル、ソーシャルトラフィック。
  • サイト間の関係：被リンク、流入参照元、流出トラフィック、類似ウェブサイト。
  • 履歴：月次の訪問数、直帰率、訪問時間、1 訪問あたりのページ数を、それぞれ独立した時系列で提供。

レスポンス

成功レスポンスは、新しい success/data の囲みを追加せず、ネイティブな JSON ボディを保持します。フィールド名、不明なフィールド、空の配列、数値の精度は変わりません。エンドポイントによって Data、Records、または別のネイティブ構造が返される場合があります。すべてに共通する行フィールドがあるとは想定しないでください。

成功した結果が空でも、そのドメインにトラフィックがないことを意味しません。失敗したリクエストを空のデータとして扱わないでください。トラブルシューティングのために X-Request-Id とリクエスト時刻を保持してください。

課金とページネーション

標準料金は、全 27 エンドポイント共通で成功したリクエスト 1 回あたり $0.0005、つまり 1,000 リクエストあたり $0.50 です。課金単位は行数ではなくリクエスト数であり、成功した結果が空でも 1 回のリクエストとして数えられます。次の各ページは別のリクエストです。アカウント固有の料金が設定されている場合は、そちらが優先されます。無効なパラメータ、認証情報の欠如、残高不足のリクエストは、成功した課金対象の呼び出しとして処理されません。失敗した上流リクエストには課金されません。

プラットフォームの最低残高ポリシーにより、呼び出し前にアカウントで $0.10 以上を利用できる必要があります。標準の請求額は、引き続き成功したリクエスト 1 回あたり $0.0005 です。

選択したエンドポイントに記載されたページネーションフィールドのみを使用してください。ページネーションは通常 1 始まりです。被リンクは Page と PageSize を使用し、その他の表では page、pageSize、rowsPerPage が使用される場合があります。未対応のページサイズフィールドを送信しないでください。

エラー

プラットフォームのエラーは次の構造を使用します。code はプラットフォームの業務コードであり、HTTP ステータスではありません。

json
{"success":false,"error":{"code":10000,"message":"Invalid request parameters"},"requestId":"..."}

主な HTTP ステータスは、400 が無効なクエリ、401 が無効な API キー、402 が残高不足、403 がゲートウェイへのアクセス拒否、429 がレート制限、5xx が上流またはサービスの一時的な失敗です。不正な形式のリクエストを変更せずに再試行しないでください。