Alertes

Permet de récupérer les alertes associées à une société.

Récupérer les alertes

GET /v1/alert

Retourne la liste des alertes d'une société avec le statut, la diffusion, la catégorie, les tags, les contacts influenceurs/décideurs et l'historique des versions.

Headers

Nom	Type	Requis	Description
x-access-token	String	oui	Clé API

Paramètres query

Nom	Type	Requis	Description
idCompany	int|int[]	conditionnel	Identifiant(s) de la société
siren	String|String[]	conditionnel	Numéro(s) SIREN
idAlert	int|int[]	conditionnel	Identifiant(s) d'alerte

TIP

Au moins un paramètre parmi idCompany, siren ou idAlert est obligatoire.

Réponses

200 — OK

{
    "success": true,
    "parameters": {
        "idAccount": "string|null",
        "idCompany": "int[]|null",
        "siren": "string[]|null",
        "idAlert": "int[]|null"
    },
    "alertList": [
        {
            "idAlert": "int",
            "idCompany": "int",
            "idAlertStatus": "int",
            "idAlertDiffusion": "int",
            "idAlertCategory": "int",
            "description": "string|null",
            "lastAlertVersion": "int|null",
            "created": "datetime",
            "modified": "datetime",
            "idSolutionRetenue": "int|null",
            "idCompanyRetenue": "int|null",
            "status": {
                "idAlertstatus": "int",
                "title": "string"
            },
            "diffusion": {
                "idAlertDiffusion": "int",
                "title": "string"
            },
            "category": {
                "idCategory": "int",
                "title": "string",
                "description": "string|null",
                "slug": "string|null"
            },
            "tagList": [
                {
                    "idTag": "int",
                    "title": "string",
                    "description": "string|null",
                    "tagType": "string|null",
                    "idCategory": "int|null"
                }
            ],
            "influenceurList": ["<RefVisitCard>"],
            "decideurList": ["<RefVisitCard>"],
            "alertVersionList": [
                {
                    "idAlertVersion": "int",
                    "idAlert": "int",
                    "idAlertMaturity": "int|null",
                    "maturityJustification": "string|null",
                    "idAlertBudgetType": "int|null",
                    "idAlertBudget": "int|null",
                    "idAlertUsers": "int|null",
                    "deadline": "date|null",
                    "idContact": "int|null",
                    "idUser": "int|null",
                    "created": "datetime",
                    "modified": "datetime",
                    "alertMaturity": {
                        "idAlertMaturity": "int",
                        "title": "string"
                    },
                    "alertBudgetType": {
                        "idAlertBudgetType": "int",
                        "title": "string"
                    },
                    "alertBudget": {
                        "idAlertBudget": "int",
                        "title": "string"
                    },
                    "alertNumberOfUsers": {
                        "idNumberOfUsers": "int",
                        "title": "string"
                    },
                    "contact": "<RefVisitCard>|null"
                }
            ],
            "solutionRetenue": {
                "idSolution": "int",
                "idSolutionVersion": "int",
                "solutionName": "string",
                "solutionEditor": "int|null",
                "solutionModified": "datetime|null",
                "solutionIsActive": "bool",
                "solutionObsoleteYear": "int|null"
            },
            "solutionVueList": ["<Solution>"],
            "companyRetenue": {
                "idCompany": "int",
                "siren": "string",
                "companyName": "string"
            },
            "companyVueList": [
                {
                    "idCompany": "int",
                    "siren": "string",
                    "companyName": "string"
                }
            ]
        }
    ]
}

Structure de l'objet <RefVisitCard> (utilisé par influenceurList, decideurList et alertVersionList[].contact) :

{
    "idRefVisitCard": "int",
    "idContact": "int",
    "idCompany": "int|null",
    "idLebonlogicielVisitCard": "int|null",
    "phone": "string|null",
    "mobile": "string|null",
    "email": "string|null",
    "leftCompany": "bool|null",
    "linkedinId": "string|null",
    "linkedinTechId": "string|null",
    "disable": "bool|null",
    "isObsolete": "bool|null",
    "created": "datetime",
    "modified": "datetime",
    "refContact": {
        "idContact": "int",
        "firstName": "string|null",
        "firstNameNormalized": "string|null",
        "lastName": "string|null",
        "lastNameNormalized": "string|null",
        "idPappers": "string|null",
        "created": "datetime",
        "modified": "datetime"
    },
    "functionList": [
        {
            "idRefVisitCardFunction": "int",
            "idRefVisitCard": "int",
            "idRefVisitCardFunctionSource": "int|null",
            "idFunctionOrigin": "int|null",
            "isCurrent": "bool|null",
            "name": "string",
            "startDate": "date|null",
            "endDate": "date|null",
            "created": "datetime",
            "modified": "datetime"
        }
    ]
}

Notes :

• solutionRetenue / companyRetenue indiquent la solution et la société retenues pour l'alerte ; solutionVueList / companyVueList les solutions et sociétés consultées. Les éléments de solutionVueList ont la même structure que solutionRetenue.
• Dans status, la clé est bien idAlertstatus (s minuscule) — c'est le nom réellement retourné par l'API.

400 — Bad Request

{
    "success": false,
    "message": "Paramètre idCompany, siren ou idAlert requis",
    "parameters": {}
}

401 — Unauthorized

{
    "success": false,
    "code": "401",
    "message": "Clé API invalide"
}

403 — Forbidden

{
    "success": false,
    "code": 403,
    "message": "L'abonnement n'a pas accès à ces données",
    "parameters": {}
}

Compter les alertes

GET /v1/alert/count

Retourne le nombre d'alertes correspondant aux filtres. Les paramètres query et les headers sont identiques à GET /v1/alert (aucun paramètre n'est obligatoire).

Réponses

200 — OK

{
    "success": true,
    "parameters": {
        "idAccount": "string|null",
        "idCompany": "int[]|null",
        "siren": "string[]|null",
        "idAlert": "int[]|null"
    },
    "result": "int"
}