Need An Email Marketing Solution For All Of Your Customers?

Partner With VerticalResponse!

getEmailCampaignStats


The getEmailCampaignStats() method provides a variety of statistical information for a given campaign specified by id.

Input

[vrtypens:getEmailCampaignStatsArgs]

session_id [xsd:string] (required)
Your API session id.
campaign_id [xsd:int] (required)
The id of the campaign whose stats are to be retrieved.
include_link_stats [xsd:boolean]
Whether to include click-through statistics in the result (default is false).
include_domain_stats [xsd:boolean]
Whether to include per-domain statistics in the result (default is false).
include_list_stats [xsd:boolean]
Whether to include per-list statistics in the result (default is false).

Output

[vrtypens:EmailCampaignStats]
The output is a variety of stats for the given campaign.

Examples

PHP

$vr->getEmailCampaignStats( array(
    'session_id'         => $sid,
    'campaign_id'        => $cid,
    'include_link_stats' => 1,
) );

Ruby

vr.getEmailCampaignStats({
    'session_id'         => sid,
    'campaign_id'        => cid,
    'include_link_stats' => 1,
})

Java

GetEmailCampaignStatsArgs emailCampaignStatsArgs = new GetEmailCampaignStatsArgs();
emailCampaignStatsArgs.setSession_id(sessionID);
emailCampaignStatsArgs.setCampaign_id(campaignID);
emailCampaignStatsArgs.setInclude_link_stats(true);

vr.getEmailCampaignStats(emailCampaignStatsArgs);

C#.NET

getEmailCampaignStatsArgs objCampaignStats = new getEmailCampaignStatsArgs();
objCampaignStats.session_id = sessionId;
objCampaignStats.campaign_id = CampaignID;
objCampaignStats.include_link_stats = true;

EmailCampaignStats objCampaignStatsResults = objVR.getEmailCampaignStats(objCampaignStats);

Perl

$vrapi->getEmailCampaignStats( {
    session_id   => $sid,
    campaign_id  => $cid,
    include_link_stats => 1,
} );