logo
AnalyticsPer-campaign analytics

Per-campaign analytics

Returns detailed analytics for a single campaign, including:

  • Campaign info and stored stats
  • Per-step breakdown (sent, opened, clicked, bounced per sequence step)
  • Lead status breakdown (active, paused, completed, bounced, etc.)
  • Total replied count and positive replied count (based on workspace AI tag settings)

Without from/to, returns all-time data. Supply one or both to filter by date range.

curl -X GET "https://api.sendkit.ai/v1/analytics/campaigns/example_string?from=2024-05-01&to=2024-05-31" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY"
{
  "success": true,
  "data": {
    "campaign": {
      "id": "664a1b2c3d4e5f6a7b8c9d02",
      "name": "Webinar Attendee Nurture",
      "status": "paused"
    },
    "stats": {
      "sent": 195,
      "delivered": 195,
      "opened": 51,
      "clicked": 16,
      "replied": 18,
      "bounced": 18,
      "unsubscribed": 8
    },
    "stepStats": [
      {
        "_id": 0,
        "sent": 103,
        "opened": 31,
        "clicked": 9,
        "bounced": 9
      },
      {
        "_id": 1,
        "sent": 61,
        "opened": 12,
        "clicked": 4,
        "bounced": 9
      },
      {
        "_id": 2,
        "sent": 31,
        "opened": 8,
        "clicked": 3,
        "bounced": 0
      }
    ],
    "statusBreakdown": {
      "failed": 6,
      "bounced": 18,
      "active": 30,
      "completed": 23,
      "unsubscribed": 8,
      "replied": 18,
      "pending": 22
    },
    "totalReplied": 18,
    "totalPositiveReplied": 8
  }
}
GET
/v1/analytics/campaigns/{campaignId}
GET
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
query
fromstring

Start date (ISO 8601 or date string). Omit for no lower bound.

Format: date
query
tostring

End date (ISO 8601 or date string). Omit for no upper bound.

Format: date
Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

Path Parameters

Query Parameters

fromstring

Start date (ISO 8601 or date string). Omit for no lower bound.

tostring

End date (ISO 8601 or date string). Omit for no upper bound.

Responses

successboolean
dataobject