get_campaign · Documentation Subagent

Contenu, audience, étapes, état, performances et première page d’historique d’une campagne accessible à cette clé.

En bref

Propriété	Valeur
Titre	Lire une campagne
Outil MCP	`get_campaign`, sur `https://api.subagent.fr/mcp`
Appel HTTP	`POST https://api.subagent.fr/v1/get_campaign`
Accès	permission `read`
État de l’espace	vérifié ou non
Effet	lecture seule
Vue dans l’assistant	oui : voir Vues

Ce que fait l’outil

Le serveur décrit l’outil ainsi à l’agent qui se branche :

Contenu, audience, étapes, état, performances et première page d’historique d’une campagne accessible à cette clé.

Paramètres

get_campaign accepte ces paramètres. Un paramètre inconnu est refusé avec le code invalid_argument.

Paramètre	Type	Obligatoire	Description
`campaign_id`	identifiant `cmp_…`	oui	Campagne.
`offset`	entier	non	De 0 à 100000.

Résultat

L’outil rend un texte lisible en français et un objet structuré (structuredContent). En HTTP, la réponse est cet objet.

Champ	Type	Contenu
`campaign`	objet	Une campagne : id (cmp_…), name, status (draft, scheduled, running, paused, completed, stopped), archived, `inbox_id`, `from_address`, `audience_id`, `reply_to`, steps (de 1 à 4 étapes : `delay_days` et variants, chacune avec subject, text, html), `starts_at`, `status_reason`, source, previous (dans `get_campaign` : les étapes qu’une correction a remplacées, avec l’auteur et l’heure de la correction), `created_at`, `updated_at`.
`history`	objet	La première page de l’historique repris, comme `campaign_history` la rend.
`metrics`	objet	Les performances, comme `campaign_metrics` les rend.

Exemple d’appel

Les valeurs sont fictives.

HTTP

curl -X POST https://api.subagent.fr/v1/get_campaign \
  -H "Authorization: Bearer $SUBAGENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "campaign_id": "cmp_6b2d9e41c7a84f03b5e1d28a90c4f7e3"
}'

MCP · tools/call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_campaign",
    "arguments": {
      "campaign_id": "cmp_6b2d9e41c7a84f03b5e1d28a90c4f7e3"
    }
  }
}

Refus possibles

Aucun refus propre à cet outil. Restent les refus communs à tous les outils (unauthorized, forbidden, invalid_argument, rate_limited, internal) : voir Erreurs.

`get_campaign`