Concours

Gérez et récupérez les informations sur vos concours.

Lister les Concours

GET/api/v1/contests

Public or Private API Key

Retourne une liste de tous les concours appartenant à l'équipe associée à votre clé API.

Requête

Aucun paramètre requis.

bash

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

javascript

const response = await fetch("https://blitzrocket.com/api/v1/contests", {
  headers: {
    "x-api-key": "your_api_key_here",
  },
});

const { success, data } = await response.json();
console.log(data);
// => [{ id: "abc123", title: "Summer Giveaway", ... }, ...]

python

import requests

response = requests.get(
    "https://blitzrocket.com/api/v1/contests",
    headers={"x-api-key": "your_api_key_here"}
)

data = response.json()
print(data["data"])
# => [{"id": "abc123", "title": "Summer Giveaway", ...}, ...]

Réponse

json

{
  "success": true,
  "data": [
    {
      "id": "clx1abc123def456",
      "title": "Summer Giveaway 2025",
      "description": "Gagnez des prix incroyables cet été !",
      "status": "active",
      "startDate": "2025-06-01T00:00:00.000Z",
      "endDate": "2025-08-31T23:59:59.000Z",
      "isEvergreen": false,
      "mode": "giveaway",
      "slug": "summer-giveaway-2025",
      "entriesCount": 1523
    },
    {
      "id": "clx2def456ghi789",
      "title": "Concours de lancement de produit",
      "description": null,
      "status": "draft",
      "startDate": null,
      "endDate": null,
      "isEvergreen": true,
      "mode": "leaderboard",
      "slug": "product-launch",
      "entriesCount": 0
    }
  ]
}

Champs de la Réponse

idstring

Identifiant unique du concours

titlestring

Le titre du concours

descriptionstring | null

Texte descriptif du concours

statusstring

Statut actuel : draft, active, ended, ou paused

startDatestring | null

Date de début au format ISO 8601, null si non défini

endDatestring | null

Date de fin au format ISO 8601, null si non défini

isEvergreenboolean

Indique si le concours est permanent

modestring

Mode du concours : giveaway, leaderboard, ou waitlist

slugstring

Identifiant unique adapté à l'URL

entriesCountnumber

Nombre total de participations au concours

Obtenir un Concours

GET/api/v1/contests/:contestId

Public or Private API Key

Récupérez les informations détaillées sur un concours spécifique.

Paramètres de Chemin

contestIdstring required

L'identifiant unique du concours