Obtenir une campagne email avec l'API Brevo
Renvoie une campagne email avec ses réglages, ses destinataires et les statistiques de son rapport.
- Identifiant
- brevo_get_email_campaign
L'appel
POST https://connect.reportei.com/api/tools/brevo_get_email_campaign/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"campaignId": 1
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| campaignId | integer | Oui | Id of the campaign, from List email campaigns. |
| statistics | string | Non | Only this group of statistics.Valeurs : globalStats, linksStats, statsByDomain, statsByDevice, statsByBrowser |
| excludeHtmlContent | boolean | Non | true leaves the HTML of the campaign out of the response. |
Connexions possibles
Votre client connecte son compte Brevo une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/brevo_get_email_campaign. Il devient la définition de tool de votre agent sans conversion.
Autres tools Brevo
- Lister les contactsGETListe les contacts, du plus récent au plus ancien par défaut, avec filtre optionnel par liste, date ou attribut. La réponse contient contacts et count ; paginez avec limit et offset.
- Obtenir un contactGETRenvoie un contact avec ses attributs, ses listes et les statistiques de campagnes des 90 derniers jours.
- Créer un contactPOSTCrée un contact. Envoyez email, ou l'attribut SMS, ou ext_id. Avec updateEnabled à true, un contact existant ayant le même identifiant est mis à jour au lieu d'échouer.
- Mettre à jour un contactPUTMet à jour un contact. Seuls les champs envoyés changent : listIds ajoute le contact à des listes et unlinkListIds l'en retire.
- Lister les listes de contactsGETListe les listes de contacts avec id, name, folderId et abonnés uniques. La réponse contient lists et count ; paginez avec limit et offset.
- Créer une liste de contactsPOSTCrée une liste de contacts vide dans un dossier et renvoie son id.
- Lister les campagnes emailGETListe les campagnes email, de la plus récente à la plus ancienne par défaut. La réponse contient campaigns et count ; paginez avec limit et offset. Les statistiques ne reviennent que si statistics est envoyé.
- Créer une campagne emailPOSTCrée une campagne email en brouillon et renvoie son id. Envoyez le contenu dans exactement un champ parmi htmlContent, htmlUrl ou templateId. Définir scheduledAt planifie l'envoi, et recipients devient alors obligatoire.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
