Get campaign analytics summary

GET /analytics/campaigns/{campaignId}/summary

Authentication

Send your organization API key as a Bearer credential.

Authorization: Bearer YOUR_API_KEY

Path parameters

campaignId string required

Query parameters

period string

Allowed values: 7d, 1m, 3m, 6m, 1y, all

start_date string

end_date string

type string

Allowed values: event, cohort

Example: event

event_types string[]

Response

application/json

Campaign summary retrieved successfully

contacted number required

Example: 125

opened number required

Example: 73

replied number required

Example: 18

bounced number required

Example: 4

interested number required

Example: 7

meta object required

Show child attributes Hide child attributes

meta.open_tracking_enabled boolean required

Whether opened metrics are available for this campaign and tracking domain

Example: true

Request

curl --request GET \
  --url https://developer.coldy.ai/api/v1/analytics/campaigns/{campaignId}/summary \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

{
  "contacted": 125,
  "opened": 73,
  "replied": 18,
  "bounced": 4,
  "interested": 7,
  "meta": {
    "open_tracking_enabled": true
  }
}

{
  "message": [
    "You put invalid API key. Verify your key with the key from your account in Coldy. Check documenation for info"
  ],
  "statusCode": 400,
  "error": "Invalid API key"
}