APIドキュメント

APIへの接続と統合方法について説明します。

APIキーを取得

ベースURL

認証

すべてのAPIエンドポイントには、Bearer認証方式で送信されるAPIキーが必要です。

Authorization: Bearer {api_key}

例

curl --request GET \
--url 'https://analytics.ipcidr.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

エラー

APIは従来のHTTPステータスコードを使用して、リクエストの成功または失敗を示します。

例

{
    "errors": [
        {
            "title": "API\u3078\u306e\u30a2\u30af\u30bb\u30b9\u6a29\u304c\u3042\u308a\u307e\u305b\u3093\u3002",
            "status": 401
        }
    ]
}

ステータスコード

200 リクエストが正常に完了

400 不正なリクエスト - 必須パラメーターが不足または無効

401 認証エラー - APIキーが不足または無効

404 リクエストされたリソースが見つかりません

429 リクエスト過多 - レート制限を超過

500 サーバー内部エラー - 当方の問題です

すべてのAPIエンドポイントの結果は、特に指定がない限り UTC タイムゾーンで動作します。

ユーザー

ウェブサイト

ページビュー

ビジター

ゴール

ゴールコンバージョン

ウェブサイト統計

カスタムドメイン

アカウントログ