Skip to content

Société de la campagne

Permet de récupérer les sociétés correspondant aux critères d'une campagne.

Récupérer les résultats de campagne

GET /v1/campaign/result

Retourne la liste des sociétés associées à une campagne avec leur statut de traitement, les dates et le suivi d'enrichissement.

Headers

NomTypeRequisDescription
x-access-tokenStringouiClé API

Paramètres query

NomTypeRequisDescription
idCampaignint|int[]nonIdentifiant(s) de la campagne
idCompanyint|int[]nonIdentifiant(s) de la société
sirenString|String[]nonNuméro(s) SIREN
companyStatusString[]nonFiltrer par statut : notYetExecuted, processing, success, inResearch, et autres statuts d'échec
idCampaignResultStatusint|int[]nonIdentifiant(s) du statut de résultat
dateMindatetimenonDate de début
dateMaxdatetimenonDate de fin
dateInsertdatetimenonDate d'insertion
minModifieddatetimenonDate de modification minimale
limitintnonNombre de résultats par page (défaut : 100)
offsetintnonDécalage pour la pagination (défaut : 0)

Réponses

200 — OK
json
{
    "success": true,
    "code": "200",
    "message": "OK",
    "parameters": {},
    "result": {
        "campaignResultList": [
            {
                "idCampaignResult": "int",
                "idCampaign": "int",
                "idCompany": "int",
                "siren": "string",
                "companyStatus": "string",
                "idCampaignResultStatus": "int",
                "dateInsert": "datetime",
                "dateExecution": "datetime|null",
                "enrichmentTracking": "object|null",
                "linkedinLinkingStatus": "string|null",
                "created": "datetime",
                "modified": "datetime"
            }
        ]
    }
}
400 — Bad Request
json
{
    "success": false,
    "code": "400",
    "message": "Paramètre incorrect"
}
401 — Unauthorized
json
{
    "success": false,
    "code": "401",
    "message": "Clé API invalide"
}

Coefficy — API externe