Skip to main content
GET
Get campaign steps analytics

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

campaign_id
string<uuid>

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

Example:

"019f985c-92b4-7fa2-9cdd-8e3b6a2e52c2"

start_date
string

Start date

Example:

"2024-01-01"

end_date
string

End date

Example:

"2024-01-01"

include_opportunities_count
boolean
default:false

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

Example:

true

Response

Default Response

step
null | string
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.

Example:

"1"

variant
null | string
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.

Example:

"0"

sent
integer
required

The total number of sent emails

Example:

5421

opened
integer
required

The total number of opened emails

Example:

99

unique_opened
integer
required

The total number of opened emails

Example:

60

replies
integer
required

The total number of replies

Example:

60

unique_replies
integer
required

The total number of replies

Example:

60

replies_automatic
integer
required

The total number of automatic replies detected

Example:

5

unique_replies_automatic
integer
required

The total number of unique automatic replies detected

Example:

4

clicks
integer
required

The total number of links clicked

Example:

60

unique_clicks
integer
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

Example:

60

opportunities
integer

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

Example:

10

unique_opportunities
integer

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

Example:

8

meetings_booked
integer

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

Example:

2

won
integer

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

Example:

1