Skip to main content
GET
/
api
/
public
/
v1
/
analytics
/
campaigns
Get campaign analytics
curl --request GET \
  --url https://api.coldsend.pro/api/public/v1/analytics/campaigns \
  --header 'X-API-Key: <api-key>'
{
  "kpis": {
    "total_campaigns": 123,
    "total_sends": 123,
    "avg_open_rate": 123,
    "avg_reply_rate": 123,
    "avg_bounce_rate": 123
  },
  "campaigns": [
    {
      "campaign_id": "<string>",
      "name": "<string>",
      "status": "<string>",
      "total_leads": 123,
      "sent_count": 123,
      "open_count": 123,
      "reply_count": 123,
      "bounce_count": 123,
      "unsubscribe_count": 123,
      "open_rate": 123,
      "reply_rate": 123,
      "bounce_rate": 123,
      "launched_at": "<string>",
      "completed_at": "<string>"
    }
  ],
  "success": true,
  "message": "Analytics retrieved successfully"
}

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Query Parameters

status
string | null

Filter by campaign status

from_date
string<date> | null

Filter by launch date (on or after)

to_date
string<date> | null

Filter by launch date (on or before)

Response

Analytics retrieved successfully

Response for campaign analytics.

kpis
PublicCampaignKPIs · object
required

Aggregate KPIs

campaigns
PublicCampaignAnalyticsItem · object[]
required

Per-campaign breakdown

success
boolean
default:true
message
string
default:Analytics retrieved successfully