#import <CampaignTrackingService.h>

Inheritance diagram for CampaignTrackingService:

Class Methods
(HttpResponse *)	+ getBouncesWithAccessToken:campaignID:creationDate:andALimitOf:

(HttpResponse *)	+ getClicksWithAccessToken:campaignId:creationDate:andALimitOf:

(HttpResponse *)	+ getForwardsWithAccessToken:campaignId:creationDate:andALimitOf:

(HttpResponse *)	+ getOpensWithAccessToken:campaignId:creationDate:andALimitOf:

(HttpResponse *)	+ getSendsWithAccessToken:campaignId:creationDate:andALimitOf:

(HttpResponse *)	+ getOptOutsWithAccessToken:campaignId:creationDate:andALimitOf:

(HttpResponse *)	+ getClicksByLinkwithAccessToken:campaignId:linkId:creationDate:andALimitOf:

(HttpResponse *)	+ getSummaryWithAccessToken:andCampaignId:

Detailed Description

Performs all actions pertaining to Constant Contact Campaign Tracking

Please note that campaign tracking data is available for 180 days from the time the campaign was originally sent. If you resend a campaign, the report data for the resend recipients is available for the same 180 day period as the original send data.

Method Documentation

+ (HttpResponse *) getBouncesWithAccessToken:	(NSString *)	accessToken
campaignID:	(NSString *)	campaignId
creationDate:	(NSDate *)	date
andALimitOf:	(int)	limit

Get a result set of bounces for a given campaign

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*campaignId - id of the Campaign to which we want to see the tracking service
NSDate	*date - (optional) if given only activites after the creation date will be returned, sending the date parameter will invalidate the limit parameter;
int	limit - (optional) query param representing the number of items returned on a page;

Returns: HttpResponse * - response containing either errors or data with a ResultsSet of BounceActivityes

+ (HttpResponse *) getClicksByLinkwithAccessToken:	(NSString *)	accessToken
campaignId:	(NSString *)	campaignId
linkId:	(NSString *)	linkId
creationDate:	(NSDate *)	date
andALimitOf:	(int)	limit

Get clicks for a specific link for a given campaign

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*campaignId - id of the Campaign to which we want to see the tracking service
NSString	*linkId - the id of the specific link you want
NSDate	*date - (optional) if given only activites after the creation date will be returned, sending the date parameter will invalidate the limit parameter;
int	limit - (optional) query param representing the number of items returned on a page;

Returns: HttpResponse * - response containing either errors or data with a ResultSet of all the Clicks on a specific link;

+ (HttpResponse *) getClicksWithAccessToken:	(NSString *)	accessToken
campaignId:	(NSString *)	campaignId
creationDate:	(NSDate *)	date
andALimitOf:	(int)	limit

Get clicks for a given campaign

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*campaignId - id of the Campaign to which we want to see the tracking service
NSDate	*date - (optional) if given only activites after the creation date will be returned, sending the date parameter will invalidate the limit parameter;
int	limit - (optional) query param representing the number of items returned on a page;

Returns: HttpResponse * - response containing either errors or data with a ResultSet of ClickActivityes

+ (HttpResponse *) getForwardsWithAccessToken:	(NSString *)	accessToken
campaignId:	(NSString *)	campaignId
creationDate:	(NSDate *)	date
andALimitOf:	(int)	limit

Get forwards for a given campaign

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*campaignId - id of the Campaign to which we want to see the tracking service
NSDate	*date - (optional) if given only activites after the creation date will be returned, sending the date parameter will invalidate the limit parameter;
int	limit - (optional) query param representing the number of items returned on a page;

Returns: HttpResponse * - response containing either errors or data with a ResultSet of ForwardActivityes

+ (HttpResponse *) getOpensWithAccessToken:	(NSString *)	accessToken
campaignId:	(NSString *)	campaignId
creationDate:	(NSDate *)	date
andALimitOf:	(int)	limit

Get opens for a given campaign

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*campaignId - id of the Campaign to which we want to see the tracking service
NSDate	*date - (optional) if given only activites after the creation date will be returned, sending the date parameter will invalidate the limit parameter;
int	limit - (optional) query param representing the number of items returned on a page;

Returns: HttpResponse * - response containing either errors or data with a ResultSet of OpenActivityes

+ (HttpResponse *) getOptOutsWithAccessToken:	(NSString *)	accessToken
campaignId:	(NSString *)	campaignId
creationDate:	(NSDate *)	date
andALimitOf:	(int)	limit

Get opt outs for a given campaign

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*campaignId - id of the Campaign to which we want to see the tracking service
NSDate	*date - (optional) if given only activites after the creation date will be returned, sending the date parameter will invalidate the limit parameter;
int	limit - (optional) query param representing the number of items returned on a page;

Returns: HttpResponse * - response containing either errors or data with a ResultSet of OptOutActivityes;

+ (HttpResponse *) getSendsWithAccessToken:	(NSString *)	accessToken
campaignId:	(NSString *)	campaignId
creationDate:	(NSDate *)	date
andALimitOf:	(int)	limit

Get sends for a given campaign

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*campaignId - id of the Campaign to which we want to see the tracking service
NSDate	*date - (optional) if given only activites after the creation date will be returned, sending the date parameter will invalidate the limit parameter;
int	limit - (optional) query param representing the number of items returned on a page;

Returns: HttpResponse * - response containing either errors or data with a ResultSet of SendActivityes

+ (HttpResponse *) getSummaryWithAccessToken:	(NSString *)	accessToken
andCampaignId:	(NSString *)	campaignId

Get a summary of reporting data for a given campaign

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*campaignId - id of the Campaign to which we want to see the tracking service

Returns: TrackingSummary * - the summary of all the tracking services related to the campaign

The documentation for this class was generated from the following files:

/Users/grigorievs/Documents/work/Code/constantcontact/ios-sdk/CTCTWrapper/Services/CampaignTrackingService.h
/Users/grigorievs/Documents/work/Code/constantcontact/ios-sdk/CTCTWrapper/Services/CampaignTrackingService.m

Class Methods

Detailed Description

Method Documentation