API Reference

Analysen

Abrufen von Leistungskennzahlen für Wettbewerbe

Analysen

Rufen Sie Leistungskennzahlen und Statistiken für Ihre Wettbewerbe ab.


Wettbewerbsanalysen abrufen

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

Gibt aggregierte Analysen für einen bestimmten Wettbewerb zurück, einschließlich Teilnehmerzahlen, Aufrufe, abgeschlossene Bonusaktionen und Punktestatistiken.

Pfadparameter

contestIdstring required

Die eindeutige Wettbewerbs-ID

Anfrage

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

Antwort

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

Antwortfelder

totalEntriesnumber

Gesamtanzahl der Einträge im Wettbewerb

confirmedEntriesnumber

Einträge mit bestätigten E-Mail-Adressen

disqualifiedEntriesnumber

Anzahl der disqualifizierten Einträge

totalViewsnumber

Gesamtanzahl der Seitenaufrufe des Wettbewerbs

totalBonusCompletionsnumber

Gesamtanzahl der abgeschlossenen Bonusaktionen aller Einträge

points.totalnumber

Summe aller Punkte aller Einträge

points.averagenumber

Durchschnittliche Punkte pro Eintrag

points.highestnumber

Höchste Punktzahl eines einzelnen Eintrags

Nutzungshinweise

  • Analysen werden in Echtzeit aus den Wettbewerbsdaten berechnet
  • Verwenden Sie diese Kennzahlen, um die Leistung und das Engagement des Wettbewerbs zu verfolgen
  • Kombinieren Sie sie mit dem Leaderboard-Endpunkt für umfassende Dashboards

Beispiel: Analyse-Dashboard

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",
  };
}

Fehlerantworten

StatusFehlerBeschreibung
400Fehlende contestIdDer Pfadparameter contestId ist erforderlich
401Ungültiger API-SchlüsselAPI-Schlüssel fehlt oder ist ungültig
404Wettbewerb nicht gefundenKein Wettbewerb mit der angegebenen ID vorhanden