Skip to main content
GET
Fetch campaign analytics

Authorizations

authorization
string
header
required

Token-based authentication. Use format: "Token token=YOUR_API_KEY" where YOUR_API_KEY is your API key

Query Parameters

id
string

campaign_mailing_send_id of a specific campaign send to total. Defaults to all sends.

drip_campaign_id
string

Total only the sends of this drip campaign

email_type
enum<string>

Total only sends of this type

Available options:
marketing_email,
drip_email
by_date
boolean

Set to true to limit totals to a time window, given either by start_date and end_date or by date_offset

start_date
string<date-time>

Start of the window, as an ISO8601 date. Used with by_date and end_date.

end_date
string<date-time>

End of the window, as an ISO8601 date. Used with by_date and start_date.

date_offset
integer

Number of days back from now to total. Used with by_date when start_date and end_date are not supplied.

Response

Campaign analytics data

data
object