Société de la campagne
Permet de récupérer les sociétés correspondant aux critères d'une campagne (entité CamCampaignResult).
Récupérer les résultats de campagne
GET/v1/campaign/resultRetourne la liste des sociétés associées à une campagne avec leur statut de traitement, les dates et le suivi détaillé des échecs (persona, enrichissement de contact, lien LinkedIn).
Headers
| Nom | Type | Requis | Description |
|---|---|---|---|
| x-access-token | String | oui | Clé API |
Paramètres query
| Nom | Type | Requis | Description |
|---|---|---|---|
| idCampaign | int|int[] | non | Identifiant(s) de la campagne |
| idCompany | int|int[] | non | Identifiant(s) de la société |
| siren | String|String[] | non | Numéro(s) SIREN (accepté mais non appliqué comme filtre actuellement — utiliser idCompany) |
| companyStatus | String | non | Filtrer par statut : any, notYetExecuted, processing, success, inResearch, failureEngage, failurePersona, failureEnrichment, failureLinkedinLink, failureAny |
| status | int|int[] | non | Identifiant(s) du statut de résultat (idCampaignResultStatus) |
| dateMin | datetime | non | Date minimale du companyStatus (format YYYY-mm-DD) |
| dateMax | datetime | non | Date maximale du companyStatus (format YYYY-mm-DD) |
| dateInsert | datetime | non | Date d'insertion dans la liste (format YYYY-mm-DD) |
| minModified | datetime | non | Date de dernière modification minimale de la ligne (format YYYY-mm-DD) |
| limit | int | non | Nombre de résultats par page (défaut : 100) |
| offset | int | non | Décalage pour la pagination (défaut : 0) |
WARNING
Les paramètres includeRegCompany, includeBranch, includeContact et includeCampaignCompanyConsume existent mais sont réservés au mode partenaire : ils sont forcés à false pour les clés API standard.
Réponses
200 — OK
json
{
"success": true,
"code": "200-21",
"parameters": {
"idAccount": "string[]|null",
"idCampaign": "int[]|null",
"idCompany": "int[]|null",
"siren": "string[]|null",
"companyStatus": "string|null",
"status": "int[]|null",
"dateMin": "datetime|null",
"dateMax": "datetime|null",
"dateInsert": "datetime|null",
"includeRegCompany": false,
"limit": "int",
"offset": "int",
"includeBranch": false,
"onlySiege": true,
"includeContact": false,
"includeCampaignCompanyConsume": false,
"campaignCompanyConsumeNoQuotaScrapped": null,
"minModified": "datetime|null"
},
"result": [
{
"idCampaign": "int",
"idCompany": "int",
"dateInsert": "datetime",
"dateLastExecuted": "datetime|null",
"idCampaignResultStatus": "int",
"idPersonaFunctionLast": "int|null",
"iterationAmount": "int|null",
"failurePersona": "bool|null",
"failureDatePersona": "datetime|null",
"failurePersonaRelaunchExecuted": "bool|null",
"failurePersonaRelaunchExecutedDate": "datetime|null",
"failurePersonaCampaignExecuted": "bool|null",
"failurePersonaCampaignExecutedDate": "datetime|null",
"failureEnrichContact": "bool|null",
"failureDateEnrichContact": "datetime|null",
"failureEnrichContactRelaunchExecuted": "bool|null",
"failureEnrichContactRelaunchExecutedDate": "datetime|null",
"failureEnrichContactCampaignExecuted": "bool|null",
"failureEnrichContactCampaignExecutedDate": "datetime|null",
"failureLinkedinLink": "bool|null",
"failureDateLinkedinLink": "datetime|null",
"isManuel": "bool",
"errorPersona": "bool",
"noQuotaScrapped": "bool",
"statusNotYetExecuted": "bool|null",
"statusProcessing": "bool|null",
"statusSuccess": "bool|null",
"statusInResearch": "bool|null",
"statusFailure": "bool|null",
"statusFailureAny": "bool|null",
"statusFailureEngage": "bool|null",
"statusFailurePersona": "bool|null",
"statusFailureEnrichment": "bool|null",
"statusFailureLinkedinLink": "bool|null",
"statusFailureScript": "bool|null",
"created": "datetime",
"modified": "datetime",
"status": {
"idCampaignResultStatus": "int",
"title": "string",
"description": "string|null",
"created": "datetime",
"modified": "datetime"
}
}
],
"count": "int"
}Notes :
- Les champs
status*reflètent l'état courant du traitement de la société dans la campagne ; les champsfailure*tracent les échecs et les relances/campagnes automatiques exécutées en conséquence. - Les champs
company,campaignResultContactListetcampaignCompanyConsumeListne sont alimentés qu'en mode partenaire (via les paramètresinclude*).
400 — Bad Request
json
{
"success": false,
"code": "400",
"message": "Le format date de dateMin n'est pas un format date reconnu: YYYY-mm-DD",
"parameters": {}
}401 — Unauthorized
json
{
"success": false,
"code": "401",
"message": "Clé API invalide"
}