TrackingService

```
public interface TrackingService
```
Retrofit interface for Email Campaign tracking calls against the Constant Contact API.
See Tracking Email Campaign Results on the Constant Contact Developer Website

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`retrofit2.Call<Paged<BounceReport>>`	`getBounceReports(java.lang.String nextLink)` Get a `Paged` collection of `BounceReport` from a `Campaign` from a previous call's next link.
`retrofit2.Call<Paged<BounceReport>>`	`getBounceReports(java.lang.String campaignId, java.lang.String createdSinceDate, int limit)` Get a `Paged` collection of `BounceReport` from a `Campaign`
`retrofit2.Call<Paged<ClickReport>>`	`getClickReports(java.lang.String nextLink)` Get a `Paged` collection of `ClickReport` from a `Campaign` from a previous call's next link.
`retrofit2.Call<Paged<ClickReport>>`	`getClickReports(java.lang.String campaignId, java.lang.String createdSinceDate, int limit)` Get a `Paged` collection of `ClickReport` from a `Campaign`
`retrofit2.Call<Paged<ClickReport>>`	`getClickReports(java.lang.String campaignId, java.lang.String linkId, java.lang.String createdSinceDate, int limit)` Get a `Paged` collection of `ClickReport` from a specific URL in a `Campaign`
`retrofit2.Call<Paged<ForwardReport>>`	`getForwardReports(java.lang.String nextLink)` Get a `Paged` collection of `ForwardReport` from a `Campaign` from a previous call's next link.
`retrofit2.Call<Paged<ForwardReport>>`	`getForwardReports(java.lang.String campaignId, java.lang.String createdSinceDate, int limit)` Get a `Paged` collection of `ForwardReport` from a `Campaign`
`retrofit2.Call<Paged<OpenReport>>`	`getOpenReports(java.lang.String nextLink)` Get a `Paged` collection of `OpenReport` from a `Campaign` from a previous call's next link.
`retrofit2.Call<Paged<OpenReport>>`	`getOpenReports(java.lang.String campaignId, java.lang.String createdSinceDate, int limit)` Get a `Paged` collection of `OpenReport` from a `Campaign`
`retrofit2.Call<Paged<OptOutReport>>`	`getOptOutReports(java.lang.String nextLink)` Get a `Paged` collection of `OptOutReport` from a `Campaign` from a previous call's next link.
`retrofit2.Call<Paged<OptOutReport>>`	`getOptOutReports(java.lang.String campaignId, java.lang.String createdSinceDate, int limit)` Get a `Paged` collection of `OptOutReport` from a `Campaign`
`retrofit2.Call<Paged<SendReport>>`	`getSendReports(java.lang.String nextLink)` Get a `Paged` collection of `SendReport` from a `Campaign` from a previous call's next link.
`retrofit2.Call<Paged<SendReport>>`	`getSendReports(java.lang.String campaignId, java.lang.String createdSinceDate, int limit)` Get a `Paged` collection of `SendReport` from a `Campaign`
`retrofit2.Call<TrackingSummary>`	`getTrackingSummary(java.lang.String campaignId)` Get the `TrackingSummary` of a `Campaign`

Method Detail

getTrackingSummary

@GET(value="v2/emailmarketing/campaigns/{campaignId}/tracking/reports/summary?updateSummary=true")
retrofit2.Call<TrackingSummary> getTrackingSummary(@Path(value="campaignId")
                                                                                                                                                      java.lang.String campaignId)

Get the TrackingSummary of a Campaign

Parameters:: campaignId - The Campaign ID
Returns:: an Observable that emits a TrackingSummary

getBounceReports

@GET(value="v2/emailmarketing/campaigns/{campaignId}/tracking/bounces")
retrofit2.Call<Paged<BounceReport>> getBounceReports(@Path(value="campaignId")
                                                                                                                             java.lang.String campaignId,
                                                                                                                             @Query(value="created_since")
                                                                                                                             java.lang.String createdSinceDate,
                                                                                                                             @Query(value="limit")
                                                                                                                             int limit)

Get a Paged collection of BounceReport from a Campaign

Parameters:: campaignId - The Campaign ID; createdSinceDate - Date to specify retrieval of reports that have been created since then, in ISO-8601 format; limit - Page size to return (1 - 500)
Returns:: an Observable that emits Paged BounceReports

getBounceReports
```
@GET(value="{path}")
retrofit2.Call<Paged<BounceReport>> getBounceReports(@Path(value="path")
                                                                          java.lang.String nextLink)
```
Get a Paged collection of BounceReport from a Campaign from a previous call's next link.

Parameters:

nextLink - Value of the path found in the meta of the original call

Returns:

an Observable that emits Paged BounceReports

See Also:

Paged

getClickReports

@GET(value="v2/emailmarketing/campaigns/{campaignId}/tracking/clicks")
retrofit2.Call<Paged<ClickReport>> getClickReports(@Path(value="campaignId")
                                                                                                                          java.lang.String campaignId,
                                                                                                                          @Query(value="created_since")
                                                                                                                          java.lang.String createdSinceDate,
                                                                                                                          @Query(value="limit")
                                                                                                                          int limit)

Get a Paged collection of ClickReport from a Campaign

Parameters:: campaignId - The Campaign ID; createdSinceDate - Date to specify retrieval of reports that have been created since then, in ISO-8601 format; limit - Page size to return (1 - 500)
Returns:: an Observable that emits Paged ClickReports

getClickReports

@GET(value="v2/emailmarketing/campaigns/{campaignId}/tracking/clicks/{linkId}")
retrofit2.Call<Paged<ClickReport>> getClickReports(@Path(value="campaignId")
                                                                                                                                   java.lang.String campaignId,
                                                                                                                                   @Path(value="linkId")
                                                                                                                                   java.lang.String linkId,
                                                                                                                                   @Query(value="created_since")
                                                                                                                                   java.lang.String createdSinceDate,
                                                                                                                                   @Query(value="limit")
                                                                                                                                   int limit)

Get a Paged collection of ClickReport from a specific URL in a Campaign

Parameters:: campaignId - The Campaign ID; linkId - The url_uid found in the click_through_details of a Campaign; createdSinceDate - Date to specify retrieval of reports that have been created since then, in ISO-8601 format; limit - Page size to return (1 - 500)
Returns:: an Observable that emits Paged ClickReports
See Also:: Campaign

getClickReports
```
@GET(value="{path}")
retrofit2.Call<Paged<ClickReport>> getClickReports(@Path(value="path")
                                                                        java.lang.String nextLink)
```
Get a Paged collection of ClickReport from a Campaign from a previous call's next link.

Parameters:

nextLink - Value of the path found in the meta of the original call

Returns:

an Observable that emits Paged ClickReports

See Also:

Paged

getForwardReports

@GET(value="v2/emailmarketing/campaigns/{campaignId}/tracking/forwards")
retrofit2.Call<Paged<ForwardReport>> getForwardReports(@Path(value="campaignId")
                                                                                                                                java.lang.String campaignId,
                                                                                                                                @Query(value="created_since")
                                                                                                                                java.lang.String createdSinceDate,
                                                                                                                                @Query(value="limit")
                                                                                                                                int limit)

Get a Paged collection of ForwardReport from a Campaign

Parameters:: campaignId - The Campaign ID; createdSinceDate - Date to specify retrieval of reports that have been created since then, in ISO-8601 format; limit - Page size to return (1 - 500)
Returns:: an Observable that emits Paged ForwardReports

getForwardReports
```
@GET(value="{path}")
retrofit2.Call<Paged<ForwardReport>> getForwardReports(@Path(value="path")
                                                                            java.lang.String nextLink)
```
Get a Paged collection of ForwardReport from a Campaign from a previous call's next link.

Parameters:

nextLink - Value of the path found in the meta of the original call

Returns:

an Observable that emits Paged ForwardReports

See Also:

Paged

getOpenReports

@GET(value="v2/emailmarketing/campaigns/{campaignId}/tracking/opens")
retrofit2.Call<Paged<OpenReport>> getOpenReports(@Path(value="campaignId")
                                                                                                                       java.lang.String campaignId,
                                                                                                                       @Query(value="created_since")
                                                                                                                       java.lang.String createdSinceDate,
                                                                                                                       @Query(value="limit")
                                                                                                                       int limit)

Get a Paged collection of OpenReport from a Campaign

Parameters:: campaignId - The Campaign ID; createdSinceDate - Date to specify retrieval of reports that have been created since then, in ISO-8601 format; limit - Page size to return (1 - 500)
Returns:: an Observable that emits Paged OpenReports

getOpenReports
```
@GET(value="{path}")
retrofit2.Call<Paged<OpenReport>> getOpenReports(@Path(value="path")
                                                                      java.lang.String nextLink)
```
Get a Paged collection of OpenReport from a Campaign from a previous call's next link.

Parameters:

nextLink - Value of the path found in the meta of the original call

Returns:

an Observable that emits Paged OpenReports

See Also:

Paged

getSendReports

@GET(value="v2/emailmarketing/campaigns/{campaignId}/tracking/sends")
retrofit2.Call<Paged<SendReport>> getSendReports(@Path(value="campaignId")
                                                                                                                       java.lang.String campaignId,
                                                                                                                       @Query(value="created_since")
                                                                                                                       java.lang.String createdSinceDate,
                                                                                                                       @Query(value="limit")
                                                                                                                       int limit)

Get a Paged collection of SendReport from a Campaign

Parameters:: campaignId - The Campaign ID; createdSinceDate - Date to specify retrieval of reports that have been created since then, in ISO-8601 format; limit - Page size to return (1 - 500)
Returns:: an Observable that emits Paged SendReports

getSendReports
```
@GET(value="{path}")
retrofit2.Call<Paged<SendReport>> getSendReports(@Path(value="path")
                                                                      java.lang.String nextLink)
```
Get a Paged collection of SendReport from a Campaign from a previous call's next link.

Parameters:

nextLink - Value of the path found in the meta of the original call

Returns:

an Observable that emits Paged SendReports

See Also:

Paged

getOptOutReports

@GET(value="v2/emailmarketing/campaigns/{campaignId}/tracking/unsubscribes")
retrofit2.Call<Paged<OptOutReport>> getOptOutReports(@Path(value="campaignId")
                                                                                                                                  java.lang.String campaignId,
                                                                                                                                  @Query(value="created_since")
                                                                                                                                  java.lang.String createdSinceDate,
                                                                                                                                  @Query(value="limit")
                                                                                                                                  int limit)

Get a Paged collection of OptOutReport from a Campaign

Parameters:: campaignId - The Campaign ID; createdSinceDate - Date to specify retrieval of reports that have been created since then, in ISO-8601 format; limit - Page size to return (1 - 500)
Returns:: an Observable that emits Paged OptOutReports

getOptOutReports
```
@GET(value="{path}")
retrofit2.Call<Paged<OptOutReport>> getOptOutReports(@Path(value="path")
                                                                          java.lang.String nextLink)
```
Get a Paged collection of OptOutReport from a Campaign from a previous call's next link.

Parameters:

nextLink - Value of the path found in the meta of the original call

Returns:

an Observable that emits Paged OptOutReports

See Also:

Paged

Interface TrackingService

Method Summary

Method Detail

getTrackingSummary

getBounceReports

getBounceReports

getClickReports

getClickReports

getClickReports

getForwardReports

getForwardReports

getOpenReports

getOpenReports

getSendReports

getSendReports

getOptOutReports

getOptOutReports