List Campaigns

Retrieve a paginated list of campaigns with engagement metrics.

GET /v1/campaigns

cURL

curl -X GET "https://api.medstrato.com/v1/campaigns?status=completed&type=product_update" \
  -H "Authorization: Bearer sk_live_your_api_key"

Response

{
  "data": [
    {
      "id": "cmp_abc123",
      "name": "TAVR 2.0 Product Launch",
      "description": "Announcing the new generation TAVR system",
      "type": "new_product_launch",
      "status": "completed",
      "audience_count": 150,
      "metrics": {
        "sent": 150,
        "delivered": 148,
        "opened": 112,
        "clicked": 45,
        "open_rate": 0.76,
        "click_rate": 0.30
      },
      "schedule": {
        "type": "immediate"
      },
      "created_at": "2024-01-05T10:00:00Z",
      "sent_at": "2024-01-05T14:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 12
  }
}

Query Parameters

page · integer · default: "1"

Page number

per_page · integer · default: "20"

Results per page (max 100)

status · string

Filter by status. Options: draft, active, paused, completed

type · string

Filter by campaign type. Options: product_update, event_invitation, new_product_launch, newsletter, custom

search · string

Search by campaign name

Response

data · array

Show Campaign object

id · string

Unique identifier

name · string

Campaign name

description · string

Campaign description

type · string

Campaign type

status · string

Current status

audience_count · integer

Number of recipients

metrics · object

Show Engagement metrics

sent · integer

Emails sent

delivered · integer

Emails delivered

opened · integer

Emails opened

clicked · integer

Links clicked

open_rate · number

Open rate (0-1)

click_rate · number

Click rate (0-1)

schedule · object

Schedule settings

created_at · string

Creation timestamp

sent_at · string

Send timestamp

cURL

curl -X GET "https://api.medstrato.com/v1/campaigns?status=completed&type=product_update" \
  -H "Authorization: Bearer sk_live_your_api_key"

Response

{
  "data": [
    {
      "id": "cmp_abc123",
      "name": "TAVR 2.0 Product Launch",
      "description": "Announcing the new generation TAVR system",
      "type": "new_product_launch",
      "status": "completed",
      "audience_count": 150,
      "metrics": {
        "sent": 150,
        "delivered": 148,
        "opened": 112,
        "clicked": 45,
        "open_rate": 0.76,
        "click_rate": 0.30
      },
      "schedule": {
        "type": "immediate"
      },
      "created_at": "2024-01-05T10:00:00Z",
      "sent_at": "2024-01-05T14:00:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 12
  }
}