MNB API v1.0 CampaignStats Method

MyNewsletterBuilder API

CampaignStats < Return to Method List

struct CampaignStats(integer $id)

Retrieve base reporting data for a sent campaign.

Parameters

integer id	The campaign id to get data for.

Return Value

struct

Returns a keyed structure of base reporting data with the following keys:

integer id	The campaign id.
integer recipients	The total number of subscribers the campaign was sent to.
integer delivered	The number of subscribers that were successfully delivered to.
integer bounced	The number of subscribers that had their emails bounce back.
integer opens	The total number of times the campaign was opened with "view images".
integer opens_unique	The number of subscribers that opened a campaign with "view images".
integer clicks	For campaigns with link-tracking enabled, the total number of clicks.
integer clicks_unique	For campaigns with link-tracking enabled, the number of subscribers that clicked in the campaign.
integer forwards	The total number of times this campaign was forwarded.
integer forwards_unique	The number of subscribers that forwarded the campaign.
integer subscribes	The number of new subscribers generated by this campaign.
integer unsubscribes	The number of unsubscribes from this campaign.
integer complaints	The number of abuse reports generated by this campaign.
string sent_on	The date/time the campaign finished sending. YYYY-MM-DD HH:II:SS.
string first_open	The date/time of the first recorded open. YYYY-MM-DD HH:II:SS.
string last_open	The date/time of the last recorded open. YYYY-MM-DD HH:II:SS.
boolean archived	If TRUE, the campaign is archived and no detailed data is available.