GET /analytics/campaigns/{campaignId}/by-account

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[]
search string
limit number

Range: x ≥ 1, x ≤ 500

Example: 50
offset number

Range: x ≥ 0

Example: 0
sort_by string

Allowed values: email, sender_provider, contacted, opened, replied, bounced, sent

Example: sent
sort_order string

Allowed values: asc, desc

Example: desc

Response

application/json

Sender-account analytics retrieved successfully

items object[] required
Show child attributes Hide child attributes
items.account_id number required
Example: 42
items.email string required
Example: sender@example.com
items.sender_provider string required
Example: google
items.contacted number required
Example: 50
items.opened number required
Example: 30
items.replied number required
Example: 8
items.bounced number required
Example: 2
items.sent number required
Example: 61
total number required
Example: 12
limit number required
Example: 50
offset number required
Example: 0
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