v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB

Campaign

Analytics

Get campaign steps analytics

get/api/v2/campaigns/analytics/steps

Query parameters

campaign_idstring uuid

Example:019f94cd-ae25-7150-8c40-4445b300e600

Campaign ID (optional). Leave this field empty to get the analytics for all campaigns

start_datestring

Example:2024-01-01

Start date

end_datestring

Example:2024-01-01

End date

include_opportunities_countboolean

Example:true

Whether to include the opportunities count per step. If this field is true then opportunities, unique_opportunities, meetings_booked, and won fields will be included in the response

Response

Default Response

stepstring nullable required

The step number. When null it means we couldn't determine the step number for the event, for instance for list leads, which are not part of a campaign.

variantstring nullable required

The variant number, starting from 0. 0 = A, 1 = B, 2 = C, etc. When null it means we couldn't determine the variant for the event.

sentinteger required

The total number of sent emails

openedinteger required

The total number of opened emails

unique_openedinteger required

The total number of opened emails

repliesinteger required

The total number of replies

unique_repliesinteger required

The total number of replies

replies_automaticinteger required

The total number of automatic replies detected

unique_replies_automaticinteger required

The total number of unique automatic replies detected

clicksinteger required

The total number of links clicked

unique_clicksinteger required

The total number of unique links clicked. Unique meaning from unique leads, not unique links. For instance, if a lead clicked a link 3 times, it will be counted as 1 unique click. If a lead clicked 3 different links, it will still be counted as 1 unique click

opportunitiesinteger

The total number of opportunities created from this step. Included only if include_opportunities_count is true

unique_opportunitiesinteger

The total number of unique opportunities created from this step. Unique meaning unique per lead. If a lead has multiple opportunities, it will be counted as 1 unique opportunity. Included only if include_opportunities_count is true

meetings_bookedinteger

The total number of opportunities from this step whose current CRM status is Meeting Booked. Included only if include_opportunities_count is true

woninteger

The total number of opportunities from this step whose current CRM status is Won. Included only if include_opportunities_count is true

Example response

[
  {
    "step": "1",
    "variant": "0",
    "sent": 5421,
    "opened": 99,
    "unique_opened": 60,
    "replies": 60,
    "unique_replies": 60,
    "replies_automatic": 5,
    "unique_replies_automatic": 4,
    "clicks": 60,
    "unique_clicks": 60,
    "opportunities": 10,
    "unique_opportunities": 8,
    "meetings_booked": 2,
    "won": 1
  }
]