Get campaign performance

Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates.

Get campaign performance

get

Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates.

Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.

Authorizations

AuthorizationstringRequired

API Token authentication

Path parameters

profileUuidstringRequired

Profile uuid parameter

Example: 550e8400-e09b-41d4-a716-400055000000

campaignUuidstringRequired

Campaign uuid parameter

Example: 550e8400-e09b-41d4-a716-400055000000

Responses

200

Success response

application/json

Campaign performance. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.

total_sentintegerOptional

Emails sent for this campaign, and the denominator of every rate below.

Example: 100

estimated_total_recipientsinteger · nullableOptional

Recipients this campaign was estimated to reach when sending started. Null for campaigns that have not started sending.

Example: 900

processed_countintegerOptionalExample: 100

delivered_countintegerOptionalExample: 90

dropped_countintegerOptionalExample: 2

bounced_countintegerOptionalExample: 8

soft_bounced_countintegerOptionalExample: 3

opened_countintegerOptional

Contacts who opened this campaign.

Example: 80

clicked_countintegerOptional

Contacts who clicked a link. Only clicks from contacts who also registered an open count.

Example: 10

unsubscribed_countintegerOptional

Contacts who unsubscribed through this campaign.

Example: 5

open_ratenumber · floatOptional

Percentage of sent emails that were opened.

Example: 42.5

click_ratenumber · floatOptional

Percentage of sent emails that got a click.

Example: 10

click_to_open_ratenumber · floatOptional

Percentage of the contacts who opened that went on to click.

Example: 23.5

unsubscribe_ratenumber · floatOptional

Percentage of sent emails that led to an unsubscribe.

Example: 1.5

has_bounced_contactsbooleanOptionalExample: false

401

Unauthenticated response

application/json

500

Error response

application/json

get/api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}/statistics

GET /api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}/statistics HTTP/1.1
Host: developers.hostinger.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total_sent": 100,
  "estimated_total_recipients": 900,
  "processed_count": 100,
  "delivered_count": 90,
  "dropped_count": 2,
  "bounced_count": 8,
  "soft_bounced_count": 3,
  "opened_count": 80,
  "clicked_count": 10,
  "unsubscribed_count": 5,
  "open_rate": 42.5,
  "click_rate": 10,
  "click_to_open_rate": 23.5,
  "unsubscribe_rate": 1.5,
  "has_bounced_contacts": false
}