API Reference

分析

コンテストのパフォーマンス指標を取得する

分析

コンテストのパフォーマンス指標と統計を取得します。


コンテスト分析を取得する

GET/api/v1/contests/:contestId/analytics
Public or Private API Key

特定のコンテストの集計分析を返します。エントリー数、閲覧数、ボーナスアクション完了数、ポイント統計などが含まれます。

パスパラメータ

contestIdstring required

一意のコンテスト識別子

リクエスト

bash
curl -X GET https://blitzrocket.com/api/v1/contests/clx1abc123/analytics \
  -H "x-api-key: your_api_key_here"

レスポンス

json
{
  "success": true,
  "data": {
    "totalEntries": 1523,
    "confirmedEntries": 1489,
    "disqualifiedEntries": 12,
    "totalViews": 28450,
    "totalBonusCompletions": 4567,
    "points": {
      "total": 45890,
      "average": 30.1,
      "highest": 890
    }
  }
}

レスポンスフィールド

totalEntriesnumber

コンテストの合計エントリー数

confirmedEntriesnumber

メールアドレスが確認されたエントリー数

disqualifiedEntriesnumber

失格となったエントリー数

totalViewsnumber

コンテストページの合計閲覧数

totalBonusCompletionsnumber

全エントリーにおけるボーナスアクション完了数の合計

points.totalnumber

全エントリーのポイント合計

points.averagenumber

エントリーあたりの平均ポイント

points.highestnumber

単一エントリーの最高ポイント

使用上の注意

  • 分析はコンテストデータからリアルタイムで計算されます
  • これらの指標を使用してコンテストのパフォーマンスとエンゲージメントを追跡します
  • リーダーボードエンドポイントと組み合わせて包括的なダッシュボードを作成できます

例:分析ダッシュボード

javascript
async function getContestDashboard(contestId, apiKey) {
  const [analyticsRes, leaderboardRes, contestRes] = await Promise.all([
    fetch(`https://blitzrocket.com/api/v1/contests/${contestId}/analytics`, {
      headers: { "x-api-key": apiKey },
    }),
    fetch(`https://blitzrocket.com/api/v1/contests/${contestId}/leaderboard?limit=5`, {
      headers: { "x-api-key": apiKey },
    }),
    fetch(`https://blitzrocket.com/api/v1/contests/${contestId}`, {
      headers: { "x-api-key": apiKey },
    }),
  ]);

  const [analytics, leaderboard, contest] = await Promise.all([
    analyticsRes.json(),
    leaderboardRes.json(),
    contestRes.json(),
  ]);

  return {
    contest: contest.data,
    analytics: analytics.data,
    topParticipants: leaderboard.data,
    conversionRate:
      analytics.data.totalViews > 0
        ? ((analytics.data.totalEntries / analytics.data.totalViews) * 100).toFixed(1)
        : "0",
  };
}

エラー応答

ステータスエラー説明
400contestIdが不足していますcontestIdパスパラメータは必須です
401無効なAPIキーAPIキーが欠落しているか無効です
404コンテストが見つかりません指定されたIDのコンテストは存在しません