get_campaign

Read the campaign

Read · mcpIdempotent

Reads the campaign: its state, its dates and the provider's counters — sent, replies, opens, bounces, and when they were measured — and, once the sending setup exists, the four launch figures the user confirms before a launch.

Description the model readsSent as is in tools/list.

Read the workspace's campaign: its state, its dates and the provider's counters (sent, replies, opens, bounces, when they were measured), and once the sending setup exists, the four launch figures the user confirms before a launch — contacts ready, sending mailboxes, emails on the first day, weekly sending window.

Example

The user says

How is my campaign doing?

tools/call · Arguments the assistant sends

{
  "name": "get_campaign",
  "arguments": {}
}

Arguments

This tool takes no arguments. {}

Input schema

{
  "type": "object",
  "properties": {}
}

Result

Result kindcampaign

kind"campaign"

outcomestring | null

What the call that rendered it did, in a sentence. Null for a plain read.

campaignobject | null

The live campaign, or the last one when none is live. Null before any.

• id string — The campaign id launch, stop and resume take. Never invent one.
• name string
• state string
• stateLabel string
• live boolean
• startsOn string | null
• endsOn string | null
• stats object | null — The last counters read from the provider. Null until a first reading.

launchRecapobject | null

What the user confirms before a launch. Null before the sending setup step.

• complete boolean — False while one of the four figures is missing.
• contacts integer — Leads ready to be pushed into the campaign.
• sendingMailboxes string[]
• firstDayEmails integer | null
• window object | null — The weekly sending window, in the workspace's timezone.

appUrlstring

Output schema

{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "const": "campaign"
    },
    "outcome": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "description": "What the call that rendered it did, in a sentence. Null for a plain read."
    },
    "campaign": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string",
              "description": "The campaign id launch, stop and resume take. Never invent one."
            },
            "name": {
              "type": "string"
            },
            "state": {
              "type": "string"
            },
            "stateLabel": {
              "type": "string"
            },
            "live": {
              "type": "boolean"
            },
            "startsOn": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "endsOn": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ]
            },
            "stats": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "sent": {
                      "type": "integer"
                    },
                    "replies": {
                      "type": "integer"
                    },
                    "opens": {
                      "type": "integer"
                    },
                    "bounces": {
                      "type": "integer"
                    },
                    "measuredAt": {
                      "type": "string",
                      "description": "When the provider's counters were last read."
                    }
                  },
                  "required": ["sent", "replies", "opens", "bounces", "measuredAt"],
                  "additionalProperties": false
                },
                {
                  "type": "null"
                }
              ],
              "description": "The last counters read from the provider. Null until a first reading."
            }
          },
          "required": [
            "id",
            "name",
            "state",
            "stateLabel",
            "live",
            "startsOn",
            "endsOn",
            "stats"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "The live campaign, or the last one when none is live. Null before any."
    },
    "launchRecap": {
      "anyOf": [
        {
          "type": "object",
          "properties": {
            "complete": {
              "type": "boolean",
              "description": "False while one of the four figures is missing."
            },
            "contacts": {
              "type": "integer",
              "description": "Leads ready to be pushed into the campaign."
            },
            "sendingMailboxes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "firstDayEmails": {
              "anyOf": [
                {
                  "type": "integer"
                },
                {
                  "type": "null"
                }
              ]
            },
            "window": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "days": {
                      "type": "array",
                      "items": {
                        "type": "string"
                      }
                    },
                    "from": {
                      "type": "string"
                    },
                    "to": {
                      "type": "string"
                    }
                  },
                  "required": ["days", "from", "to"],
                  "additionalProperties": false
                },
                {
                  "type": "null"
                }
              ],
              "description": "The weekly sending window, in the workspace's timezone."
            }
          },
          "required": [
            "complete",
            "contacts",
            "sendingMailboxes",
            "firstDayEmails",
            "window"
          ],
          "additionalProperties": false
        },
        {
          "type": "null"
        }
      ],
      "description": "What the user confirms before a launch. Null before the sending setup step."
    },
    "appUrl": {
      "type": "string"
    }
  },
  "required": ["kind", "outcome", "campaign", "launchRecap", "appUrl"],
  "additionalProperties": false
}

Good to know

• The four launch figures: contacts ready, sending mailboxes, emails on the first day, weekly sending window.
• Its campaign id is the one launch_campaign, stop_campaign and resume_campaign take.

Related tools

launch_campaignLaunch the campaign

list_repliesList prospect replies

stage_campaignPrepare the campaign