Obtenir les statistiques d'une campagne avec l'API Instantly
Renvoie, par campagne, leads, contactés, emails envoyés, ouvertures, réponses, clics sur les liens, rebonds, désinscriptions, leads terminés et opportunités, pour une campagne ou pour toutes.
- Identifiant
- instantly_get_campaign_analytics
L'appel
POST https://connect.reportei.com/api/tools/instantly_get_campaign_analytics/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"id": "<id>"
}
}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 |
|---|---|---|---|
| id | string | Non | Id of the campaign, from List campaigns. Omit it for every campaign. |
| start_date | string | Non | Start of the period, as a date like 2026-10-01 (UTC midnight) or a full ISO 8601 timestamp. |
| end_date | string | Non | End of the period, in the same formats as start_date. |
| exclude_total_leads_count | boolean | Non | When true, leaves out the total of leads, which makes the call much faster. |
Connexions possibles
Votre client connecte son compte Instantly 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/instantly_get_campaign_analytics. Il devient la définition de tool de votre agent sans conversion.
Autres tools Instantly
- Lister les campagnesGETListe les campagnes du workspace avec id, nom et statut, jusqu'à limit par page. Pour la page suivante, passez next_starting_after comme starting_after, jusqu'à ce qu'il ne revienne plus.
- Obtenir une campagneGETRenvoie une campagne avec statut, planning, sequences (les étapes d'email et leurs variantes), comptes d'envoi dans email_list et options d'envoi.
- Créer une campagnePOSTCrée une campagne en brouillon, avec son planning, ses étapes d'email et ses comptes d'envoi. Ajoutez des leads avec Create lead et lancez-la avec Activate campaign.
- Mettre à jour une campagnePATCHModifie une campagne. Envoyez uniquement les champs à changer ; sequences et campaign_schedule remplacent entièrement les actuels.
- Activer une campagnePOSTDémarre une campagne en brouillon ou reprend une campagne en pause. Instantly envoie alors les étapes aux leads de la campagne, depuis les comptes de email_list, dans le planning.
- Mettre une campagne en pausePOSTMet une campagne en pause : plus aucun email ne part tant qu'Activate campaign ne la reprend pas.
- Lister les leadsPOSTListe les leads avec email, noms, entreprise, statut et statut d'intérêt, jusqu'à limit par page. Pour la page suivante, passez next_starting_after comme starting_after, jusqu'à ce qu'il ne revienne plus.
- Créer un leadPOSTAjoute un lead à une campagne ou à une liste de leads. Un lead ajouté à une campagne active entre dans la séquence et reçoit des emails selon le planning.
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.
