Back to Documentation Overview

campaignStats

public static campaignStats(string uid, string cid)

Given a list and a campaign, get all the relevant campaign statistics (opens, bounces, clicks, etc.)

Section:
Campaign Stats
Parameters:
uid the id for your user account. Get by calling login($user, $pass)
cid the campaign id to pull stats for (can be gathered using campaigns($id))
Returns:
array   -  struct of the statistics for this campaign
Returned Fields:
integer syntax_errors Number of email addresses in campaign that had syntactical errors.
integer hard_bounces Number of email addresses in campaign that hard bounced.
integer soft_bounces Number of email addresses in campaign that soft bounced.
integer unsubscribes Number of email addresses in campaign that unsubscribed.
integer abuse_reports Number of email addresses in campaign that reported campaign for abuse.
integer forwards Number of times email was forwarded to a friend.
integer forwards_opens Number of times a forwarded email was opened.
integer opens Number of times the campaign was opened.
date last_open Date of the last time the email was opened.
integer unique_opens Number of people who opened the campaign.
integer clicks Number of times a link in the campaign was clicked.
integer unique_clicks Number of unique recipient/click pairs for the campaign.
date last_click Date of the last time a link in the email was clicked.
integer users_who_clicked Number of unique recipients who clicked on a link in the campaign.
integer emails_sent Number of email addresses campaign was sent to.
Add New Note User Contributed Notes for campaignStats
No notes, yet... Will you be the first??