Lire les métriques | Documentation Prescriptio

POST /api/mcp/v1/email.metrics.get, portée mcp:read; droits, conditions d’offre et quotas contrôlés par l’action. Même traitement que l'outil campagne_email_suivi.

exemple synthétique

curl -sS https://prescriptio.fr/api/mcp/v1/email.metrics.get \
  -H 'Authorization: Bearer <jeton>' \
  -H 'Content-Type: application/json' \
  -d '{}'

{}

Réponsegénérée depuis le schéma

{
  "action": "<stats_campagne | releve_canal>",
  "fields": {
    "lignes": [
      {
        "canal": "<texte>",
        "clics": 0,
        "delivres": 0,
        "desinscrits": 0,
        "echecs": 0,
        "envoyes": 0,
        "periode": "<texte>",
        "prepares": 0,
        "quota": 0,
        "relances": 0,
        "reponses": 0
      }
    ],
    "par_contact": [
      {
        "clics": 0,
        "email": "<texte>",
        "entreprise_cle": "<texte>",
        "envoye_le": "<texte>",
        "erreur": "<texte>",
        "fonction": "<texte>",
        "id": "<texte>",
        "livraison": "<texte>",
        "mode": "<texte>",
        "nom": "<texte>",
        "ouvertures": 0,
        "palier": 0,
        "personnalisation": {},
        "planifie_le": "<texte>",
        "prenom": "<texte>",
        "rang": 0,
        "societe": "<texte>",
        "source": "<texte>",
        "statut": "<texte>",
        "variante": "<texte>",
        "ville": "<texte>"
      }
    ],
    "quota": {
      "au_dela": 0,
      "du_cents": 0,
      "envoyes": 0,
      "envoyes_jour": 0,
      "inclus_restants": 0,
      "mois": "<texte>",
      "plafond_jour": 0,
      "plafond_mois_inclus": 0,
      "prix_unitaire_cents": 0,
      "reglage_propre": false
    },
    "stats": {
      "annules": 0,
      "clics": 0,
      "contacts_ayant_clique": 0,
      "desinscrits": 0,
      "destinataires": 0,
      "echecs": 0,
      "en_journal": 0,
      "envoyes": 0,
      "planifies": 0,
      "repondus": 0
    },
    "suivi": [
      {
        "campagne_id": "<texte>",
        "contacts_ayant_ouvert": 0,
        "livraisons": [
          {
            "nombre": null,
            "statut": null
          }
        ]
      }
    ]
  },
  "note": "<texte>",
  "ok": null,
  "url": "<texte>"
}

Paramètres du corps

campagne_idtexte

UUID de la campagne. Requis partout sauf lister, creer, stats (global), desinscrits, expediteur et quota.

periodetexte

Stats : campagne (le détail d'une campagne, par contact) ou canal (les chiffres du jour, des 7 et des 30 jours, forme commune aux canaux de prospection). (valeurs : campagne · canal)

En bref

Adresse: POST /api/mcp/v1/email.metrics.get
Contrat: 3.0.0
Portée OAuth: mcp:read
Conditions d’accès: Chaque action conserve ses droits, ses conditions d’offre et ses quotas ; sa présence dans le catalogue ne les lève pas.
Outil MCP: campagne_email_suivi : même traitement

Erreurs et quotas

Cet outil ne consomme aucune unité de dossier : chercher est gratuit, c'est la lecture d'un dossier (marches_dce, mairies_deliberations et leurs téléchargements) qui est décomptée.

Les codes HTTP, le corps d’erreur et les compteurs d’appels et de dossiers sont communs. Chaque action conserve aussi ses droits et plafonds métier : Codes d'erreur et Authentification et quotas.

Les pages qui s'en servent

Calculé depuis la documentation : chaque page qui cite email.metrics.get.

Campagnes e-mail de bout en boutGuides, Parcours complets API RESTIA, Intégrations

Voir aussi

Référence APIL'adresse, l'authentification et les codes de réponse campagne_email_suiviLa même action par le connecteur MCP OpenAPILe schéma machine de toutes les opérations

{ "action": "<stats_campagne | releve_canal>", "fields": { "lignes": [ { "canal": "<texte>", "clics": 0, "delivres": 0, "desinscrits": 0, "echecs": 0, "envoyes": 0, "periode": "<texte>", "prepares": 0, "quota": 0, "relances": 0, "reponses": 0 } ], "par_contact": [ { "clics": 0, "email": "<texte>", "entreprise_cle": "<texte>", "envoye_le": "<texte>", "erreur": "<texte>", "fonction": "<texte>", "id": "<texte>", "livraison": "<texte>", "mode": "<texte>", "nom": "<texte>", "ouvertures": 0, "palier": 0, "personnalisation": {}, "planifie_le": "<texte>", "prenom": "<texte>", "rang": 0, "societe": "<texte>", "source": "<texte>", "statut": "<texte>", "variante": "<texte>", "ville": "<texte>" } ], "quota": { "au_dela": 0, "du_cents": 0, "envoyes": 0, "envoyes_jour": 0, "inclus_restants": 0, "mois": "<texte>", "plafond_jour": 0, "plafond_mois_inclus": 0, "prix_unitaire_cents": 0, "reglage_propre": false }, "stats": { "annules": 0, "clics": 0, "contacts_ayant_clique": 0, "desinscrits": 0, "destinataires": 0, "echecs": 0, "en_journal": 0, "envoyes": 0, "planifies": 0, "repondus": 0 }, "suivi": [ { "campagne_id": "<texte>", "contacts_ayant_ouvert": 0, "livraisons": [ { "nombre": null, "statut": null } ] } ] }, "note": "<texte>", "ok": null, "url": "<texte>" }

[Index de la documentation](https://prescriptio.fr/docs/llms.txt) # Lire les métriques L'opération REST email.metrics.get de Prescriptio sert à lire les métriques d'une campagne ou du canal e-mail. ### Exemple d'appel, synthétique **curl** ```bash curl -sS https://prescriptio.fr/api/mcp/v1/email.metrics.get \ -H 'Authorization: Bearer <jeton>' \ -H 'Content-Type: application/json' \ -d '{}' ``` **Corps JSON** ```json {} ``` ### Forme de la réponse, générée depuis le schéma ```json { "action": "<stats_campagne | releve_canal>", "fields": { "lignes": [ { "canal": "<texte>", "clics": 0, "delivres": 0, "desinscrits": 0, "echecs": 0, "envoyes": 0, "periode": "<texte>", "prepares": 0, "quota": 0, "relances": 0, "reponses": 0 } ], "par_contact": [ { "clics": 0, "email": "<texte>", "entreprise_cle": "<texte>", "envoye_le": "<texte>", "erreur": "<texte>", "fonction": "<texte>", "id": "<texte>", "livraison": "<texte>", "mode": "<texte>", "nom": "<texte>", "ouvertures": 0, "palier": 0, "personnalisation": {}, "planifie_le": "<texte>", "prenom": "<texte>", "rang": 0, "societe": "<texte>", "source": "<texte>", "statut": "<texte>", "variante": "<texte>", "ville": "<texte>" } ], "quota": { "au_dela": 0, "du_cents": 0, "envoyes": 0, "envoyes_jour": 0, "inclus_restants": 0, "mois": "<texte>", "plafond_jour": 0, "plafond_mois_inclus": 0, "prix_unitaire_cents": 0, "reglage_propre": false }, "stats": { "annules": 0, "clics": 0, "contacts_ayant_clique": 0, "desinscrits": 0, "destinataires": 0, "echecs": 0, "en_journal": 0, "envoyes": 0, "planifies": 0, "repondus": 0 }, "suivi": [ { "campagne_id": "<texte>", "contacts_ayant_ouvert": 0, "livraisons": [ { "nombre": null, "statut": null } ] } ] }, "note": "<texte>", "ok": null, "url": "<texte>" } ``` ## Paramètres du corps | Nom | Type | Requis | Description | |---|---|---|---| | `campagne_id` | texte | — | UUID de la campagne. Requis partout sauf lister, creer, stats (global), desinscrits, expediteur et quota. | | `periode` | texte | — | stats : campagne (le détail d'une campagne, par contact) ou canal (les chiffres du jour, des 7 et des 30 jours, forme commune aux canaux de prospection). (valeurs : `campagne` · `canal`) | ## En bref | | | |---|---| | Adresse | `POST /api/mcp/v1/email.metrics.get` | | Contrat | 3.0.0 | | Portée OAuth | `mcp:read` | | Conditions d’accès | Chaque action conserve ses droits, ses conditions d’offre et ses quotas ; sa présence dans le catalogue ne les lève pas. | | Outil MCP | [`campagne_email_suivi`](https://prescriptio.fr/docs/api/campagne_email_suivi) : même traitement | ## Erreurs et quotas Cet outil ne consomme aucune unité de dossier : chercher est gratuit, c'est la lecture d'un dossier (`marches_dce`, `mairies_deliberations` et leurs téléchargements) qui est décomptée. Les codes HTTP, le corps d’erreur et les compteurs d’appels et de dossiers sont communs. Chaque action conserve aussi ses droits et plafonds métier : [Codes d'erreur](https://prescriptio.fr/docs/reference/erreurs) et [Authentification et quotas](https://prescriptio.fr/docs/reference/authentification#les-quotas). ## Les pages qui s'en servent Calculé depuis la documentation : chaque page qui cite `email.metrics.get`. - [Campagnes e-mail de bout en bout](https://prescriptio.fr/docs/guides/campagnes-email) : Guides, Parcours complets - [API REST](https://prescriptio.fr/docs/integrations/api-rest) : IA, Intégrations ## Voir aussi - [Référence API](https://prescriptio.fr/docs/reference) : L'adresse, l'authentification et les codes de réponse - [campagne_email_suivi](https://prescriptio.fr/docs/api/campagne_email_suivi) : La même action par le connecteur MCP - [OpenAPI](https://prescriptio.fr/openapi.json) : Le schéma machine de toutes les opérations