ContactTrackingService Class Reference

#import <ContactTrackingService.h>

Inheritance diagram for ContactTrackingService:

Class Methods
(HttpResponse *)	+ getBouncesWithAccessToken:contactId:andALimitOf:
(HttpResponse *)	+ getClicksWithAccessToken:contactId:creationDate:andALimitOf:
(HttpResponse *)	+ getForwardsWithAccessToken:contactId:creationDate:andALimitOf:
(HttpResponse *)	+ getOpensWithAccessToken:contactId:creationDate:andALimitOf:
(HttpResponse *)	+ getSendsWithAccessToken:contactId:creationDate:andALimitOf:
(HttpResponse *)	+ getUnsubscribesWithAccessToken:contactId:creationDate:andALimitOf:
(HttpResponse *)	+ getSummaryWithAccessToken:contactId:
(HttpResponse *)	+ getActivitesSortedByEmailCampaignWithAccessToken:contactId:
(HttpResponse *)	+ getAllContactActivitesWithAccessToken:contactId:creationDate:andALimitOf:

Detailed Description

Performs all actions pertaining to Contact Tracking

Please note that activity data is available for 180 days from the time a campaign is sent.

Method Documentation

+ (HttpResponse *) getActivitesSortedByEmailCampaignWithAccessToken:		(NSString *)	accessToken
contactId:		(NSString *)	contactId

Get all the activites of the user sorted by email campaign

Parameters

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

Returns

HttpResponse * - response containing either "ERROR" or @"data" with the activites of the user sorted by email campaign

+ (HttpResponse *) getAllContactActivitesWithAccessToken:		(NSString *)	accessToken
contactId:		(NSString *)	contactId
creationDate:		(NSDate *)	date
andALimitOf:		(int)	limit

Get all e activites of the user

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*contactId - id of the contact to which we want to see the tracking service
int	limit - (optional) the number of elements returned on one page;
NSDate	*date - (optional) if given only activites after the creation date will be returned, sending the date parameter will invalidate the limit parameter;

Returns

HttpResponse * - response containing either "ERROR" or @"data" with the activites of the user

+ (HttpResponse *) getBouncesWithAccessToken:		(NSString *)	accessToken
contactId:		(NSString *)	contactId
andALimitOf:		(int)	limit

Get bounces for a given contact

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*contactId - id of the contact to which we want to see the tracking service
int	limit - (optional) query param representing the number of items returned on a page

Returns

HttpResponse *- response containing a results array of BounceActivityes

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

Get clicks for a given contact

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*contactId - id of the contact 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 "ERROR" or @"data" with a ResultSet of ClickActivityes

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

Get forwards for a given contact

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*contactId - id of the contact 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 "ERROR" or @"data" with a ResultSet of ForwardActivityes

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

Get opens for a given contact

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*contactId - id of the contact 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 "ERROR" or @"data" with a ResultSet of OpenActivityes

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

Get sends for a given contact

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*contactId - id of the contact 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 "ERROR" or @"data" with a ResultSet of SendActivityes

+ (HttpResponse *) getSummaryWithAccessToken:		(NSString *)	accessToken
contactId:		(NSString *)	contactId

Get a summary of reporting data for a given contact

Parameters

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

Returns

HttpResponse * - response containing either "ERROR" or @"data" with a summary reguarding all activites of a specific contact

+ (HttpResponse *) getUnsubscribesWithAccessToken:		(NSString *)	accessToken
contactId:		(NSString *)	contactId
creationDate:		(NSDate *)	date
andALimitOf:		(int)	limit

Get opt outs for a given contact

Parameters

NSString	*accessToken - Constant Contact OAuth2 access token
NSString	*contactId - id of the contact 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 "ERROR" or @"data" with a ResultSet of OptOutActivityes

---

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

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