Follow

Show Campaign Statistics

The Show Campaign Statistics command allows you to return statistical details for a single campaign.  It requires the following arguments: Command, Realm, Password, and Campaign ID.

api_web?r=myrealm&p=mypass&c=show_campaign_stats&campaign_id=11

The command is ‘show_campaign_stats’, the realm is ‘myrealm’ and the password is ‘mypass’.  The command will return the following details for the campaign with id='11':

Campaign ID

Campaign Identifier

List Name

Name of the list

List ID

List Identifier

Subject

Subject Line of message

Date

Date and time message sent

Recipients

Number of subscribers sent the message

Alias

Campaign Alias

Template Name

Name of the template

Segmentation

Name of the Segmentation Rule

Active

How long the campaign has been active, time since deployed

Set Macro ID

Identifier for Set Data Macro used during campaign. ID will be 0 if not set.

Character Set

Name of character set defined in template

Unicode

True if Unicode was defined in template, otherwise blank

Quoted Printable

True if quoted printable formatting was defined in template, otherwise blank

Forced Format

Message format sent Plain, HTML, MULTI or Auto

Deployed By

Email address of person that deployed the list

Auto Multipart

True if auto merge was set in the list, otherwise False (This feature has been deprecated, and the reported data is no longer valid)

Wrap Plain

True if plain text wrapping was set in the list, otherwise False (This feature has been deprecated, and the reported data is no longer valid)

Wrap HTML

True if HTML wrapping was set in the list, otherwise False (This feature has been deprecated, and the reported data is no longer valid)

Track Opens

True (1) if open events are tracked, otherwise False (0)

Track Clicks

True (1) if click events are tracked, otherwise False (0)

Deliverability

Yes if campaign was seeded for deliverability report, otherwise No

Hard Bounces

Number of hard bounced messages

Soft Bounces

Number of soft bounced messages

Unsubscribes*

Number of unsubscribes and list level opt-outs*

Global Unsubscribes*

Number of global (Account level) opt-outs*

Display Message Count

Number of times the display message link clicked

Total Opened

Number of messages opened

Total Clicks

Number of tracking links clicked

Total FTAFs

Number of FTAF links clicked

Total Opened Unique

Number of messages opened per subscriber

Complaint Bounces

Number of feedback loop abuse complaints received.  Only displayed if version 7.3.0 or newer included in command.

Blocked Bounces

Number of reports that messages are blocked. Only displayed if version 7.3.0 or newer included in command.

Social Shares
Social Views
Social Clicks
Social Provider Count
 

Social Provider Statistics include total number of Shares, Views and Clicks as well as a total number of Social Providers.  Only displayed if version 8.4.0 or newer included in command. 

Social Network Statistics

Social Network Statistics include number of Shares, Views and Clicks separated for each Social Network. Only displayed if version 8.4.0 or newer included in command. Columns include:

  • Digg Shares
  • Digg Views
  • Digg Clicks
  • Facebook Shares
  • Facebook Views
  • Facebook Clicks
  • LinkedIn Shares
  • LinkedIn Views
  • LinkedIn Clicks
  • Myspace Shares
  • Myspace Views
  • Myspace Clicks
  • Twitter Shares
  • Twitter Views
  • Twitter Clicks
  • Google+ Shares
  • Google+ Views
  • Google+ Clicks
  • StumbleUpon Shares
  • StumbleUpon Views
  • StumbleUpon Clicks
  • Pinterest Shares
  • Pinterest Views
  • Pinterest Clicks

Unique Clicks

Number of messages clicked per subscriber.  Only displayed if version 12.05 or newer included in command. 

Example

Using all commands and arguments (please note the command is wrapped for display purposes only):

api_web?c=show_campaign_stats&r=myrealm&p=mypass&campaign_id=11&version=12.05.0&output_format=csv&headers=1

Successful results return:

"Campaign ID","List Name","List ID","Subject","Date","Recipients","Alias","Template Name","Segmentation","Active","Set Macro ID","Character Set","Unicode","Quoted Printable","Forced Format","Deployed By","Auto Multipart","Wrap Plain","Wrap HTML","Track Opens","Track Clicks","Deliverability","Hard Bounces","Soft Bounces","Unsubscribes","Global Unsubscribes","Display Message Count","Total Opened","Total Clicks","Total FTAFs","Total Opened Unique","Complaint Bounces","Blocked Bounces","Social Shares","Social Views","Social Clicks","Social Provider Count","Digg Shares","Digg Views","Digg Clicks","Facebook Shares","Facebook Views","Facebook Clicks","LinkedIn Shares","LinkedIn Views","LinkedIn Clicks","Myspace Shares","Myspace Views","Myspace Clicks","Twitter Shares","Twitter Views","Twitter Clicks","Google+ Shares","Google+ Views","Google+ Clicks","StumbleUpon Shares","StumbleUpon Views","StumbleUpon Clicks","Pinterest Shares","Pinterest Views","Pinterest Clicks","Unique Clicks"
"11","My List","5","My Subject","11/02/15 10:38 AM","274","My Campaign","My Template","All users","448 days 21 hours 58 minutes","0","UTF-8","","","html","jane@mydomain.com","true","false","false", "1","1","no","113","5","0","10","2","23","29","0","18","3","2","0","0","0","8","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","14"

Results

The Show Campaign Statistics command outputs either the results of the search or a FAILURE message. 

SUCCESS

The Show Campaign Statistics command does not explicitly return a Success code.  Instead, it outputs the campaign id, list name, subject, date sent, and number of recipients in plain text format.  Use the output_format argument to return the results in an alternate format.

FAILURE

A Show Campaign Statistics command will fail for several reasons, such as if the campaign doesn't exist.  The result format is:

FAILURE: [Reason]  

Arguments

The Show Campaign Statistics command supports the following arguments:

Name

Req?

Description

Argument

Command

Yes

Defines the command to use.

cmd=show_campaign_stats

c=show_campaign_stats

Realm

Yes

Name of the realm to run the command.  This is required, and the command will fail if the realm and password do not match.

realm=[realm_name]

r=[realm_name]

Password

Yes

Authentication code for API access.  This is required, and the command will fail if the realm and password do not match.

pwd=[password]

p=[password]

Campaign ID

Yes

Identifier for the campaign data to return.

campaign_id=[campaign_id]

Version   Version of API to use.  Data may be added to newer versions of the API.  To alleviate issues for users who have already coded file parsing, new columns are only displayed if the version is included.

version=[version_number]

7.3.0 = complaint and block bounce totals
8.4.0 = social share statistics
12.05 = unique clicks

Output Format

 

To specify the format of the list output, use one of two arguments.  If no argument is included, the default output is space-delimited plain text string, which may not include all data columns.

csv=1 or

output_format=[csv,csv_tab, csv_pipe,xml]

Header

 

To define the data with a label, use the Header argument.  This can only be used in conjunction with the output format, and does not affect XML.

headers=[0,1]

DEFAULT==0

 

*The Unsubscribes data split into Unsubscribes and Global Unsubscribes columns in version 11.10.  

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk