Get a campaign

Get a campaign

curl --request GET \
  --url https://atoms-api.smallest.ai/api/v1/campaign/{id} \
  --header 'Authorization: Bearer <token>'

{
  "status": true,
  "data": {
    "campaign": {
      "_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "organization": "<string>",
      "agentId": "<string>",
      "createdBy": "<string>",
      "audienceId": "<string>",
      "participantsCount": 123,
      "status": "draft",
      "maxRetries": 3,
      "retryDelay": 15,
      "scheduledAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "events": [
      {
        "_id": "<string>",
        "campaignId": "<string>",
        "triggerSource": "<string>",
        "eventAction": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "metrics": {
      "total_participants": 500,
      "contacts_called": 247,
      "contacts_connected": 150
    }
  }
}

GET

campaign

{id}

Get a campaign

curl --request GET \
  --url https://atoms-api.smallest.ai/api/v1/campaign/{id} \
  --header 'Authorization: Bearer <token>'

{
  "status": true,
  "data": {
    "campaign": {
      "_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "organization": "<string>",
      "agentId": "<string>",
      "createdBy": "<string>",
      "audienceId": "<string>",
      "participantsCount": 123,
      "status": "draft",
      "maxRetries": 3,
      "retryDelay": 15,
      "scheduledAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "events": [
      {
        "_id": "<string>",
        "campaignId": "<string>",
        "triggerSource": "<string>",
        "eventAction": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "metrics": {
      "total_participants": 500,
      "contacts_called": 247,
      "contacts_connected": 150
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The ID of the campaign

Response

Campaign details with metrics

status

boolean

Example:

true

data

object

Show child attributes

data.campaign

object

Show child attributes

data.campaign._id

string

The unique identifier for the campaign

data.campaign.name

string

The name of the campaign

data.campaign.description

string

The description of the campaign

data.campaign.organization

string

The ID of the organization

data.campaign.agentId

string

The ID of the agent

data.campaign.createdBy

string

The ID of the user who created the campaign

data.campaign.audienceId

string

The ID of the audience

data.campaign.participantsCount

integer

The number of participants in the campaign

data.campaign.status

enum<string>

The current status of the campaign

Available options:

draft,

scheduled,

running,

paused,

scheduled_for_retry,

completed

data.campaign.maxRetries

integer

Maximum number of retry attempts

Example:

3

data.campaign.retryDelay

integer

Delay between retries in minutes

Example:

15

data.campaign.scheduledAt

string<date-time>

Scheduled start time for the campaign

data.campaign.createdAt

string<date-time>

The date and time when the campaign was created

data.campaign.updatedAt

string<date-time>

The date and time when the campaign was last updated

data.events

object[]

Campaign events history

Show child attributes

data.events._id

string

data.events.campaignId

string

data.events.triggerSource

string

data.events.eventAction

string

data.events.createdAt

string<date-time>

data.metrics

object

Campaign performance metrics

Show child attributes

data.metrics.total_participants

integer

Total number of contacts in the campaign audience

Example:

500

data.metrics.contacts_called

integer

Number of unique contacts where call was attempted (statuses IN_PROGRESS, COMPLETED, FAILED, NO_ANSWER)

Example:

247

data.metrics.contacts_connected

integer

Number of unique contacts who answered and had a conversation (status COMPLETED)

Example:

150

Create a campaign Delete a campaign

⌘I

User

Organization

Agent Templates

Agents

Workflows

Logs

Calls

Campaigns

Knowledge Base

Phone Numbers

Webhooks

Audience

Authorizations

Path Parameters

Response