3分で読めます

API リファレンス

Zenovay API を使用すると、分析データにプログラムからアクセスできます。

認証

すべての API リクエストには認証が必要です。External API は X-API-Key ヘッダーを使用します。API キーは Pro プラン以上で利用可能です。ダッシュボードの Settings → Security → API keys から生成できます。

Authentication HeaderBash

curl -H "X-API-Key: YOUR_API_KEY" \
https://api.zenovay.com/api/external/v1/analytics/WEBSITE_ID

ベース URL

External API のベース URL は以下の通りです:

https://api.zenovay.com/api/external/v1

レート制限

External API は有料プランでのみ利用可能です。Free プランではプログラマティック API アクセスは含まれていません。

プラン	1 分あたりのリクエスト	月間制限
Free	API アクセスなし	API アクセスなし
Pro	30	10,000
Scale	60	100,000
Enterprise	120	1,000,000

レート制限ヘッダーはすべてのレスポンスに含まれます:

X-RateLimit-Limit: リクエスト制限
X-RateLimit-Remaining: 残りリクエスト数
X-RateLimit-Reset: 制限がリセットされる Unix タイムスタンプ

エンドポイント

アナリティクス

GET/analytics/{websiteId}

ウェブサイトの分析データを取得

パラメータ

パラメータ	タイプ	必須	説明
`websiteId`	string	はい	ウェブサイト ID
`range`	string	いいえ	時間範囲: `24h`, `7d`, `30d`, `90d` (デフォルト: `7d`)

レスポンス

ResponseJSON

{
"website": {
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "domain": "example.com",
  "name": "My Website"
},
"timeRange": "7d",
"totalVisitors": 1247,
"totalPageViews": 3891,
"bounceRate": 42.3,
"topCountries": [
  {
    "name": "United States",
    "code": "US",
    "visitors": 456,
    "percentage": 36.6
  }
],
"dailyStats": [
  {
    "date": "2025-01-01",
    "visitors": 178,
    "pageViews": 542,
    "bounceRate": 38.2
  }
]
}

リアルタイムデータ

GET/track/realtime/{websiteId}

リアルタイム訪問者データを取得

レスポンス

ResponseJSON

{
"count": 23,
"visitors": [
  {
    "id": "visitor-123",
    "country_name": "United States",
    "city": "New York",
    "device_type": "desktop",
    "value_score": 78,
    "visited_at": "2025-01-01T12:34:56Z"
  }
],
"timestamp": "2025-01-01T12:35:00Z"
}

ウェブサイト管理

GET/websites

すべてのウェブサイトをリスト表示

レスポンス

ResponseJSON

{
"websites": [
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "domain": "example.com",
    "name": "My Website",
    "tracking_code": "abc123def456",
    "is_active": true,
    "created_at": "2025-01-01T00:00:00Z"
  }
]
}

POST/websites

新しいウェブサイトを作成

リクエストボディ

RequestJSON

{
"domain": "newsite.com",
"name": "My New Website"
}

レスポンス

ResponseJSON

{
"website": {
  "id": "789e0123-e89b-12d3-a456-426614174000",
  "domain": "newsite.com",
  "name": "My New Website",
  "tracking_code": "xyz789abc123",
  "is_active": true,
  "created_at": "2025-01-01T12:00:00Z"
}
}

エラーハンドリング

API は標準的な HTTP ステータスコードを使用します:

ステータスコード	説明
200	成功
400	Bad Request - パラメータが無効です
401	Unauthorized - API キーが無効です
403	Forbidden - 権限不足です
404	Not Found - リソースが見つかりません
429	Too Many Requests - レート制限を超過しました
500	Internal Server Error

Error ResponseJSON

{
"error": "Website not found",
"message": "The specified website ID does not exist or you don't have access to it"
}

API の使用

標準的な HTTP リクエストを使用して、任意の言語から External API を呼び出すことができます:

cURL

curl -X GET "https://api.zenovay.com/api/external/v1/analytics/WEBSITE_ID" \
-H "X-API-Key: YOUR_API_KEY"

Bash