ComRaidComRaid Docs
API referenceCampaigns

Get Campaign and child Messages

Returns the Campaign, its child Messages, `message_counts` keyed by Message status (`scheduled`, `preparing`, `processing`, `completed`, `failed`, `cancelled`), and `delivery_totals` (nested Delivery rollups + CTR summed across child Messages; same nesting as Message `status_summary`).

GET
/campaigns/{id}

Returns the Campaign, its child Messages, message_counts keyed by Message status (scheduled, preparing, processing, completed, failed, cancelled), and delivery_totals (nested Delivery rollups + CTR summed across child Messages; same nesting as Message status_summary).

Authorization

bearerAuth
headerAuthorizationBearer <API key>

Project API key (cr_sk_...)

Path Parameters

id*string
Formatuuid

Response Body

Campaign detail including child Messages, Message counts, and Delivery totals

application/json
  1. response
campaign_id*string
Formatuuid
channel*string
status*string
Value in"queued""processing""completed""failed""cancelled"
name?string
created_at?string
Formatdate-time
message_count?integer
message_counts*

Counts of child Messages under a Campaign, keyed by Message status. Every status key is always present (zero when none).

delivery_totals*

Nested Delivery rollups summed over every child Message of the Campaign. Same nesting as Message status_summary: delivered ⊆ sent, opened ⊆ delivered; ctr is opened ÷ delivered (0 when delivered is 0).

messages*array<>
Example Request
curl -X GET 'https://api.comraid.io/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904",  "channel": "string",  "status": "queued",  "name": "string",  "created_at": "2019-08-24T14:15:22Z",  "message_count": 0,  "message_counts": {    "scheduled": 0,    "preparing": 0,    "processing": 0,    "completed": 0,    "failed": 0,    "cancelled": 0  },  "delivery_totals": {    "queued": 0,    "processing": 0,    "sent": 0,    "failed": 0,    "skipped": 0,    "remaining": 0,    "delivered": 0,    "opened": 0,    "total": 0,    "ctr": 0.1  },  "messages": [    {      "message_id": "d7d9d9fd-478f-40e6-b651-49b7f19878a2",      "external_user_id": "string",      "status": "scheduled",      "title": "string",      "body": "string",      "delivery_count": 0    }  ]}