API Campagnes

Lister et récupérer les informations des campagnes.

Lister les Campagnes

Obtenir une liste de toutes les campagnes de votre organisation.

Endpoint


GET /api/campaigns

Exemple de Requête


curl -X GET NEXT_PUBLIC_BASE_URL/api/campaigns \
  -H "x-api-key: votre-cle-api"

Schéma de Réponse

Champ	Type	Description
`campaigns`	`array`	Liste des campagnes
`campaigns[].id`	`string`	Identifiant unique de la campagne
`campaigns[].name`	`string`	Nom de la campagne
`campaigns[].createdAt`	`string`	Timestamp ISO 8601 de création

Exemple de Réponse


{
  "campaigns": [
    {
      "id": "clxyz123",
      "name": "Série de Bienvenue",
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "id": "clxyz456",
      "name": "Newsletter Janvier",
      "createdAt": "2024-01-10T08:00:00.000Z"
    }
  ]
}

Obtenir les Détails d’une Campagne

Obtenir des informations détaillées sur une campagne spécifique, y compris tous les emails.

Endpoint


GET /api/campaigns/:id

Paramètres de Chemin

Paramètre	Type	Description
`id`	`string`	ID de la Campagne

Exemple de Requête


curl -X GET NEXT_PUBLIC_BASE_URL/api/campaigns/clxyz123 \
  -H "x-api-key: votre-cle-api"

Schéma de Réponse

Champ	Type	Description
`id`	`string`	ID de la Campagne
`name`	`string`	Nom de la Campagne
`createdAt`	`string`	Timestamp ISO 8601
`stats`	`object`	Statistiques de la Campagne
`stats.totalEmails`	`number`	Total des emails dans la campagne
`stats.totalOpens`	`number`	Total des ouvertures pour tous les emails
`stats.totalClicks`	`number`	Total des clics pour tous les emails
`stats.openRate`	`number`	Pourcentage du taux d’ouverture
`stats.clickRate`	`number`	Pourcentage du taux de clics
`links`	`array`	Statistiques agrégées des liens
`links[].url`	`string`	URL originale du lien
`links[].clicks`	`number`	Total des clics sur ce lien
`emails`	`array`	Liste des emails dans la campagne

Exemple de Réponse


{
  "id": "clxyz123",
  "name": "Série de Bienvenue",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "stats": {
    "totalEmails": 1250,
    "totalOpens": 856,
    "totalClicks": 302,
    "openRate": 68.48,
    "clickRate": 24.16
  },
  "links": [
    {
      "url": "https://example.com/signup",
      "clicks": 156
    },
    {
      "url": "https://example.com/learn-more",
      "clicks": 89
    }
  ],
  "emails": [
    {
      "id": "email123",
      "trackingId": "hE4kJ9",
      "recipient": "user@example.com",
      "subject": "Bienvenue sur notre service !",
      "createdAt": "2024-01-15T10:32:00.000Z",
      "opens": 2,
      "clicks": 1
    }
  ]
}

Créer une Campagne

Créer une nouvelle campagne dans votre organisation.

Endpoint


POST /api/campaigns

Corps de la Requête

Champ	Type	Requis	Description
`name`	`string`	Oui	Nom de la campagne (doit être unique dans l’organisation)

Exemple de Requête


curl -X POST NEXT_PUBLIC_BASE_URL/api/campaigns \
  -H "x-api-key: votre-cle-api" \
  -H "Content-Type: application/json" \
  -d '{"name": "Série de Bienvenue"}'

Schéma de Réponse

Champ	Type	Description
`id`	`string`	Identifiant unique de la campagne
`name`	`string`	Nom de la campagne
`createdAt`	`string`	Timestamp ISO 8601 de création

Exemple de Réponse


{
  "id": "clxyz123",
  "name": "Série de Bienvenue",
  "createdAt": "2024-01-15T10:30:00.000Z"
}

Archiver une Campagne

Archiver une campagne. Les campagnes archivées sont exclues des listes et n’acceptent plus de nouveaux emails.

Endpoint


POST /api/campaigns/:id/archive

Paramètres de Chemin

Paramètre	Type	Description
`id`	`string`	ID de la Campagne

Exemple de Requête


curl -X POST NEXT_PUBLIC_BASE_URL/api/campaigns/clxyz123/archive \
  -H "x-api-key: votre-cle-api"

Exemple de Réponse


{
  "success": true
}

Réponses d’Erreur

Statut	Description
`400 Bad Request`	Champs requis manquants ou campagne déjà archivée
`401 Unauthorized`	Clé API invalide ou manquante
`403 Forbidden`	Limite de campagnes atteinte sur le plan actuel
`404 Not Found`	Campagne non trouvée ou n’appartenant pas à votre organisation
`409 Conflict`	Une campagne avec ce nom existe déjà

Exemple d’Erreur


{
  "error": "Campagne non trouvée"
}