Overview

Namespaces

  • Ctct
    • Auth
    • Components
      • Account
      • Activities
      • Contacts
      • EmailMarketing
      • Library
      • Tracking
    • Exceptions
    • Services
    • Util
    • WebHooks

Classes

  • AccountService
  • ActivityService
  • BaseService
  • CampaignScheduleService
  • CampaignTrackingService
  • ContactService
  • ContactTrackingService
  • EmailMarketingService
  • LibraryService
  • ListService
  • Overview
  • Namespace
  • Class

Class CampaignTrackingService

Performs all actions pertaining to Constant Contact Campaign Tracking

Ctct\Services\BaseService
Extended by Ctct\Services\CampaignTrackingService
Namespace: Ctct\Services
Package: Services
Author: Constant Contact
Located at Services/CampaignTrackingService.php
Methods summary
public Ctct\Components\ResultSet
# getBounces( string $accessToken, string $campaignId, array $params = array() )

Get a result set of bounces for a given campaign

Get a result set of bounces for a given campaign

Parameters

$accessToken
  • Constant Contact OAuth2 access token
$campaignId
  • Campaign id
$params
  • associative array of query parameters and values to append to the request. Allowed parameters include: limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50. created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format). next - the next link returned from a previous paginated call. May only be used by itself.

Returns

Ctct\Components\ResultSet
  • Containing a results array of Ctct\Components\Tracking\BounceActivity

Throws

Ctct\Exceptions\CtctException
public Ctct\Components\ResultSet
# getClicks( string $accessToken, string $campaignId, array $params = array() )

Get clicks for a given campaign

Get clicks for a given campaign

Parameters

$accessToken
  • Constant Contact OAuth2 access token
$campaignId
  • Campaign id
$params
  • associative array of query parameters and values to append to the request. Allowed parameters include: limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50. created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format). next - the next link returned from a previous paginated call. May only be used by itself.

Returns

Ctct\Components\ResultSet
  • Containing a results array of Ctct\Components\Tracking\ClickActivity

Throws

Ctct\Exceptions\CtctException
public Ctct\Components\ResultSet
# getForwards( string $accessToken, string $campaignId, array $params = array() )

Get forwards for a given campaign

Get forwards for a given campaign

Parameters

$accessToken
  • Constant Contact OAuth2 access token
$campaignId
  • Campaign id
$params
  • associative array of query parameters and values to append to the request. Allowed parameters include: limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50. created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format). next - the next link returned from a previous paginated call. May only be used by itself.

Returns

Ctct\Components\ResultSet
  • Containing a results array of Ctct\Components\Tracking\ForwardActivity

Throws

Ctct\Exceptions\CtctException
public Ctct\Components\ResultSet
# getOpens( string $accessToken, string $campaignId, array $params = array() )

Get opens for a given campaign

Get opens for a given campaign

Parameters

$accessToken
  • Constant Contact OAuth2 access token
$campaignId
  • Campaign id
$params
  • associative array of query parameters and values to append to the request. Allowed parameters include: limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50. created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format). next - the next link returned from a previous paginated call. May only be used by itself.

Returns

Ctct\Components\ResultSet
  • Containing a results array of Ctct\Components\Tracking\OpenActivity

Throws

Ctct\Exceptions\CtctException
public Ctct\Components\Tracking\TrackingActivity
# getSends( string $accessToken, string $campaignId, array $params = array() )

Get sends for a given campaign

Get sends for a given campaign

Parameters

$accessToken
  • Constant Contact OAuth2 access token
$campaignId
  • Campaign id
$params

= array() - associative array of query parameters and values to append to the request. Allowed parameters include: limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50. created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format). next - the next link returned from a previous paginated call. May only be used by itself.

Returns

Ctct\Components\Tracking\TrackingActivity
  • Containing a results array of Ctct\Components\Tracking\SendActivity

Throws

Ctct\Exceptions\CtctException
public Ctct\Components\ResultSet
# getUnsubscribes( string $accessToken, string $campaignId, array $params = array() )

Get unsubscribes for a given campaign

Get unsubscribes for a given campaign

Parameters

$accessToken
  • Constant Contact OAuth2 access token
$campaignId
  • Campaign id
$params
  • associative array of query parameters and values to append to the request. Allowed parameters include: limit - Specifies the number of results displayed per page of output, from 1 - 500, default = 50. created_since - Used to retrieve a list of events since the date and time specified (in ISO-8601 format). next - the next link returned from a previous paginated call. May only be used by itself.

Returns

Ctct\Components\ResultSet
  • Containing a results array of Ctct\Components\Tracking\UnsubscribeActivity

Throws

Ctct\Exceptions\CtctException
public Ctct\Components\Tracking\TrackingSummary
# getSummary( string $accessToken, integer $campaignId )

Get a summary of reporting data for a given campaign

Get a summary of reporting data for a given campaign

Parameters

$accessToken
  • Constant Contact OAuth2 access token
$campaignId
  • Campaign id

Returns

Ctct\Components\Tracking\TrackingSummary

Throws

Ctct\Exceptions\CtctException
Methods inherited from Ctct\Services\BaseService
__construct(), convertException(), createBaseRequest(), getClient()
API documentation generated by ApiGen