API Reference

Analyse

Prestaties van wedstrijden ophalen

Analyse

Haal prestatiegegevens en statistieken op voor je wedstrijden.


Wedstrijdanalyse ophalen

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

Geeft geaggregeerde analysegegevens terug voor een specifieke wedstrijd, inclusief aantal inzendingen, weergaven, voltooide bonusacties en puntstatistieken.

Padparameters

contestIdstring required

De unieke wedstrijdidentificatie

Verzoek

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

Antwoord

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

Antwoordvelden

totalEntriesnumber

Totaal aantal inzendingen in de wedstrijd

confirmedEntriesnumber

Inzendingen met bevestigde e-mailadressen

disqualifiedEntriesnumber

Aantal gediskwalificeerde inzendingen

totalViewsnumber

Totaal aantal paginaweergaven van de wedstrijd

totalBonusCompletionsnumber

Totaal aantal voltooide bonusacties over alle inzendingen

points.totalnumber

Som van alle punten over alle inzendingen

points.averagenumber

Gemiddeld aantal punten per inzending

points.highestnumber

Hoogste puntentotaal voor een enkele inzending

Gebruikstips

  • Analysegegevens worden in realtime berekend op basis van de wedstrijdgegevens
  • Gebruik deze statistieken om de prestaties en betrokkenheid van wedstrijden te volgen
  • Combineer met de leaderboard-endpoint voor uitgebreide dashboards

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

Foutantwoorden

StatusFoutBeschrijving
400Ontbrekende contestIdDe contestId padparameter is verplicht
401Ongeldige API-sleutelAPI-sleutel ontbreekt of is ongeldig
404Wedstrijd niet gevondenEr bestaat geen wedstrijd met de opgegeven ID