v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB

Campaign

Analytics

Get campaign(s) analytics

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

get/api/v2/campaigns/analytics

Query parameters

idstring uuid

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

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

idsstring[]

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

start_datestring

Example:2024-01-01

Start date

end_datestring

Example:2024-01-01

End date

exclude_total_leads_countboolean

Example:true

Exclude the total leads from the result. Setting this to true will considerably decrease the response time

Response

Default Response

campaign_namestring required

The name of the campaign

campaign_idstring uuid required

The ID of the campaign

campaign_statusnumber required

The campaign status

campaign_is_evergreenboolean required

Whether the campaign is evergreen

leads_countinteger required

The total number of leads

contacted_countinteger required

Number of leads for whom the sequence has started

emails_sent_countinteger required

The total number of sent emails

new_leads_contacted_countinteger required

The total number of new leads contacted

open_countinteger required

The number of leads that opened at least one email

open_count_uniqueinteger

The number of unique email opens (first open per lead)

open_count_unique_by_stepinteger

The number of unique email opens per step (first open per lead per step)

reply_countinteger required

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 detected

reply_count_automatic_uniqueinteger

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

reply_count_automatic_unique_by_stepinteger

The number of unique automatic replies per step

link_click_countinteger required

The number of links that got clicked

link_click_count_uniqueinteger

The number of unique link clicks (first click per lead)

link_click_count_unique_by_stepinteger

The number of unique link clicks per step (first click per lead per step)

bounced_countinteger required

The number of bounced leads

unsubscribed_countinteger required

The number of unsubscribed leads

completed_countinteger required

The number of leads that the campaign was completed for

total_opportunitiesinteger required

The total number of unique opportunities created

total_opportunity_valuenumber required

The total value of opportunities created

Example response

[
  {
    "campaign_name": "My Test Campaign",
    "campaign_id": "019f94cd-ae23-7bf9-b7ce-c8fc71654d68",
    "campaign_status": 1,
    "campaign_is_evergreen": true,
    "leads_count": 1500,
    "contacted_count": 1200,
    "emails_sent_count": 5000,
    "new_leads_contacted_count": 200,
    "open_count": 800,
    "open_count_unique": 750,
    "open_count_unique_by_step": 900,
    "reply_count": 300,
    "reply_count_unique": 280,
    "reply_count_unique_by_step": 350,
    "reply_count_automatic": 15,
    "reply_count_automatic_unique": 12,
    "reply_count_automatic_unique_by_step": 18,
    "link_click_count": 800,
    "link_click_count_unique": 600,
    "link_click_count_unique_by_step": 720,
    "bounced_count": 50,
    "unsubscribed_count": 20,
    "completed_count": 1100,
    "total_opportunities": 10,
    "total_opportunity_value": 1000
  }
]