API Reference
Analytique
Récupérer les métriques de performance du concours
Analytique
Récupérez les métriques de performance et les statistiques de vos concours.
Obtenir les analyses du concours
GET
/api/v1/contests/:contestId/analytics Public or Private API Key
Retourne les analyses agrégées pour un concours spécifique, incluant le nombre d’entrées, les vues, les complétions d’actions bonus et les statistiques de points.
Paramètres de chemin
contestIdstring required L’identifiant unique du concours
Requête
bash
curl -X GET https://blitzrocket.com/api/v1/contests/clx1abc123/analytics \
-H "x-api-key: your_api_key_here"
Réponse
json
{
"success": true,
"data": {
"totalEntries": 1523,
"confirmedEntries": 1489,
"disqualifiedEntries": 12,
"totalViews": 28450,
"totalBonusCompletions": 4567,
"points": {
"total": 45890,
"average": 30.1,
"highest": 890
}
}
}
Champs de réponse
totalEntriesnumberNombre total d’entrées dans le concours
confirmedEntriesnumberEntrées avec adresses e-mail confirmées
disqualifiedEntriesnumberNombre d’entrées disqualifiées
totalViewsnumberNombre total de vues de la page du concours
totalBonusCompletionsnumberNombre total de complétions d’actions bonus pour toutes les entrées
points.totalnumberSomme de tous les points pour toutes les entrées
points.averagenumberPoints moyens par entrée
points.highestnumberTotal de points le plus élevé pour une seule entrée
Notes d’utilisation
- Les analyses sont calculées en temps réel à partir des données du concours
- Utilisez ces métriques pour suivre la performance et l’engagement du concours
- Combinez avec le point de terminaison du classement pour des tableaux de bord complets
Exemple : Tableau de bord analytique
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",
};
}
Réponses d’erreur
| Statut | Erreur | Description |
|---|---|---|
400 | contestId manquant | Le paramètre de chemin contestId est requis |
401 | Clé API invalide | La clé API est manquante ou invalide |
404 | Concours non trouvé | Aucun concours n’existe avec l’ID donné |