v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB

Campaign

Analytics

Get campaign(s) analytics overview

Get analytics overview for one or multiple campaigns. Specify the id field to get the analytics overview for a single campaign, or leave it empty to get the analytics overview for all campaigns.

Note regarding the interest status totals (interested, meeting booked, meeting completed, closed): these are calculated based on the first occurrence of each event per contact by default. To change this behavior and calculate the totals based on all occurrences of the events, set the expand_crm_events parameter to true. Additionally, there is a 10 minute time window after you change a lead status in which the subsequent updates will NOT insert new analytics events to avoid duplicates from rapid status changes and avoid false inflation of the analytics numbers.

get/api/v2/campaigns/analytics/overview

Query parameters

idstring uuid

Example:019f94cd-ae23-7bf9-b7ce-c8fdb472c07d

A campaign ID to get the analytics overview for. Leave this field empty to get the analytics overview for all campaigns

idsstring[]

[
  "019f94cd-ae23-7bf9-b7ce-c8fe8e341d5a"
]

start_datestring

Example:2024-01-01

Start date

end_datestring

Example:2024-01-01

End date

campaign_status-99 | -1 | -2 | 0 | 1 | 2 | 3 | 4

Example:1

Filter by campaign status (only the analytics for the campaigns with the specified status will be returned)

expand_crm_eventsboolean

Example:true

When true, calculates the total of all the lead interest status update events instead of only the first occurrence for each contact. This will affect the following fields: total_opportunities, total_interested, total_meeting_booked, total_meeting_completed, and total_closed. Example: if a lead goes from interested to meeting booked to closed, it will count as 3 events (total_interested: 1, total_meeting_booked_1, and total_closed: 1) when this parameter is set to true, and as 1 event (total_interested) when it is set to false (default).

Response

Default Response

open_countinteger

The total number of times the emails were opened, including duplicates

open_count_uniqueinteger

The number of emails that got opened (for the first time only)

open_count_unique_by_stepinteger

The unique number of times the emails were opened (counted once per lead, step, and campaign)

link_click_countinteger

The number of links that got clicked

link_click_count_uniqueinteger

The number of links that got clicked (for the first time)

link_click_count_unique_by_stepinteger

The unique number of links that got clicked, per step (counted once per lead, step, and campaign)

reply_countinteger

The total number of replies received (if a lead replies multiple times, each reply is counted)

reply_count_uniqueinteger

The number of unique replies (first reply per lead). Excludes automatic replies.

reply_count_unique_by_stepinteger

The number of unique replies per step (first reply per lead per step). Excludes automatic replies.

reply_count_automaticinteger

The total number of automatic replies received (e.g., out-of-office)

reply_count_automatic_uniqueinteger

The number of unique leads that sent automatic replies

reply_count_automatic_unique_by_stepinteger

The unique number of automatic replies per step (counted once per lead, step, and campaign)

bounced_countinteger

The number of bounced leads

unsubscribed_countinteger

The number of unsubscribed leads

completed_countinteger

The number of leads that the campaign was completed for

emails_sent_countinteger

The total number of sent emails

contacted_countinteger

The total number of unique leads contacted

new_leads_contacted_countinteger

The total number of new leads contacted

total_opportunitiesinteger

The total number of unique opportunities created

total_opportunity_valuenumber

The total value of opportunities created

total_interestedinteger

The total number of interested opportunities created

total_meeting_bookedinteger

The total number of meeting booked opportunities created

total_meeting_completedinteger

The total number of meeting completed opportunities created

total_closedinteger

The total number of closed opportunities created

Example response

{
  "open_count": 800,
  "open_count_unique": 800,
  "open_count_unique_by_step": 800,
  "link_click_count": 800,
  "link_click_count_unique": 800,
  "link_click_count_unique_by_step": 800,
  "reply_count": 300,
  "reply_count_unique": 300,
  "reply_count_unique_by_step": 300,
  "reply_count_automatic": 50,
  "reply_count_automatic_unique": 45,
  "reply_count_automatic_unique_by_step": 45,
  "bounced_count": 50,
  "unsubscribed_count": 20,
  "completed_count": 1100,
  "emails_sent_count": 5000,
  "contacted_count": 4500,
  "new_leads_contacted_count": 200,
  "total_opportunities": 10,
  "total_opportunity_value": 1000,
  "total_interested": 103,
  "total_meeting_booked": 45,
  "total_meeting_completed": 12,
  "total_closed": 10
}