Récupérer des statistiques sur vos missions

Accéder aux statistiques de performance de vos missions, incluant les impressions, les redirections, les créations de compte et les candidatures générées, en appliquant les filtres de votre choix.

GET https://api.api-engagement.beta.gouv.fr/v0/view/stats

Query Parameters

Name

Type

Description

facets

string

Champs des statistiques sur lesquels vous souhaitez avoir les agrégations. Vous pouvez en indiquer plusieurs en les séparant par une virgule ","

type

string

Filter par le type de stats que vous souhaitez agréger. print (impression) ou apply (candidature) ou click (redirection) ou account (création de compte)

toPublisherId

string

Filter par le partenaire vers qui les stats sont envoyés

fromPublisherId

string

Filter par le partenaire vers qui reçoivent les stats

createdAt

gt:Date / lt:Date

Filter par la date de création des statistiques. Avant (lt), après (gt) ou les deux.

Ex: gt:2022-03-25 & lt:2022-05-25

Headers

Name

Type

Description

x-api-key requis

string

La clé API nécessaire à l’authentification. Les données disponibles sont définies en fonction de votre clé API.

// facets=fromPublisherName,type
{
    "total": 6724560,
    "facets": {
        "fromPublisherName": [
            {
                "key": "publisher_name_1",
                "doc_count": 1014071
            },
            {
                "key": "publisher_name_2",
                "doc_count": 992850
            },
            {
                "key": "publisher_name_3",
                "doc_count": 794433
            },
            [...]
        ],
        "type": [
            {
                "key": "print",
                "doc_count": 4520465
            },
            {
                "key": "click",
                "doc_count": 2083903
            },
            {
                "key": "apply",
                "doc_count": 102851
            },
            {
                "key": "account",
                "doc_count": 17341
            }
        ]
    }
}

{
    "ok": false,
    "code": "INVALID_QUERY",
    "error": [
        {
            "message": "\"size\" must be a number",
            "path": [
                "size"
            ],
            "type": "number.base",
            "context": {
                "label": "size",
                "value": "deux",
                "key": "size"
            }
        }
    ]
}

{
    "ok": false,
    "code": "SERVER_ERROR"
}

PreviousRécupérer les statistiques d'une mission NextRécupérer la liste de mes partenaires diffuseurs

Last updated 2 months ago

// facets=fromPublisherName,type { "total": 6724560, "facets": { "fromPublisherName": [ { "key": "publisher_name_1", "doc_count": 1014071 }, { "key": "publisher_name_2", "doc_count": 992850 }, { "key": "publisher_name_3", "doc_count": 794433 }, [...] ], "type": [ { "key": "print", "doc_count": 4520465 }, { "key": "click", "doc_count": 2083903 }, { "key": "apply", "doc_count": 102851 }, { "key": "account", "doc_count": 17341 } ] } }

{ "ok": false, "code": "INVALID_QUERY", "error": [ { "message": "\"size\" must be a number", "path": [ "size" ], "type": "number.base", "context": { "label": "size", "value": "deux", "key": "size" } } ] }