Get a campaign | Smallest AI Docs

from smallest_ai import SmallestAI
client = SmallestAI(
    token="YOUR_TOKEN_HERE",
)
client.atoms.campaigns.get_a_campaign(
    id="id",
)

{
  "status": true,
  "data": {
    "campaign": {
      "_id": "string",
      "name": "string",
      "description": "string",
      "organization": "string",
      "agentId": "string",
      "createdBy": "string",
      "audienceId": "string",
      "participantsCount": 1,
      "status": "draft",
      "maxRetries": 3,
      "retryDelay": 15,
      "scheduledAt": "2024-01-15T09:30:00Z",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z"
    },
    "events": [
      {
        "_id": "string",
        "campaignId": "string",
        "triggerSource": "string",
        "eventAction": "string",
        "createdAt": "2024-01-15T09:30:00Z"
      }
    ],
    "metrics": {
      "total_participants": 500,
      "contacts_called": 247,
      "contacts_connected": 150
    }
  }
}

Get a campaign with detailed metrics

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Path parameters

idstringRequired

The ID of the campaign

Response

Campaign details with metrics

statusboolean

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error