Obtenir les statistiques d'une campagne avec l'API Constant Contact
Renvoie les statistiques de suivi d'une campagne e-mail envoyée : envois uniques, ouvertures, clics, rebonds, transferts et désabonnements dans stats, les taux en pourcentage et last_refresh_time.
- Identifiant
- constant_contact_get_email_campaign_stats
L'appel
POST https://connect.reportei.com/api/tools/constant_contact_get_email_campaign_stats/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"campaign_ids": "<campaign_ids>"
}
}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 |
|---|---|---|---|
| campaign_ids | string | Oui | campaign_id of one campaign, from List email campaigns. |
Connexions possibles
Votre client connecte son compte Constant Contact une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/constant_contact, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.
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/constant_contact_get_email_campaign_stats. Il devient la définition de tool de votre agent sans conversion.
Autres tools Constant Contact
- Lister les contactsGETListe les contacts du compte, sans les supprimés par défaut, avec filtre facultatif par e-mail, liste, statut ou date. La réponse contient contacts et, quand il y en a plus, _links.next.href avec le curseur de la page suivante.
- Créer un contactPOSTCrée un contact et le renvoie avec son contact_id. Envoyez create_source et au moins email_address, first_name ou last_name. Une adresse e-mail déjà présente dans le compte répond 409.
- Mettre à jour un contactPUTMet à jour un contact en remplaçant ses champs principaux : email_address, noms, job_title, company_name, birthday et anniversary omis deviennent vides, envoyez donc aussi les valeurs actuelles, obtenues via Lister les contacts. Les sous-ressources omises sont conservées, et celle qui est envoyée remplace l'actuelle.
- Lister les listes de contactsGETListe les listes de contacts avec list_id, name et description. Un compte compte jusqu'à 1000 listes, et une page en renvoie jusqu'à 1000.
- Créer une liste de contactsPOSTCrée une liste de contacts vide et la renvoie avec son list_id. Un nom déjà utilisé par une autre liste répond 409.
- Lister les campagnes e-mailGETListe les campagnes e-mail, de la plus récemment mise à jour à la plus ancienne, avec campaign_id, name, type et current_status, y compris les supprimées (Removed). Jusqu'à 500 par page ; atteignez les plus anciennes avec before_date et after_date. Les ids des activités viennent d'Obtenir une campagne e-mail.
- Obtenir une campagne e-mailGETRenvoie une campagne e-mail avec name, current_status et campaign_activities. Le campaign_activity_id avec role primary_email est celui que prennent les outils d'activité.
- Créer une campagne e-mailPOSTCrée une campagne e-mail en brouillon avec du contenu HTML personnalisé et la renvoie avec campaign_activities, où se trouve l'activité primary_email. Pour l'envoyer, définissez les listes avec Mettre à jour l'activité de la campagne e-mail puis utilisez Planifier l'activité de la campagne e-mail.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
