net.nextpulse.postmarkapp.api.server

Class StatsAPIApi

java.lang.Object

net.nextpulse.postmarkapp.api.server.StatsAPIApi

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-02-24T16:43:29.220+01:00")
public class StatsAPIApi
extends Object

Constructor Summary

Constructors

Constructor and Description
StatsAPIApi()
StatsAPIApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
InlineResponse200	getBounceCounts(String xPostmarkServerToken, String tag, Date fromdate, Date todate) Get bounce counts
DynamicResponse	getOutboundClickCounts(String xPostmarkServerToken, String tag, Date fromdate, Date todate) Get click counts
Object	getOutboundClickCountsByBrowserFamily(String xPostmarkServerToken, String tag, Date fromdate, Date todate) Get browser usage by family
DynamicResponse	getOutboundClickCountsByLocation(String xPostmarkServerToken, String tag, Date fromdate, Date todate) Get clicks by body location
DynamicResponse	getOutboundClickCountsByPlatform(String xPostmarkServerToken, String tag, Date fromdate, Date todate) Get browser plaform usage
InlineResponse2001	getOutboundOpenCounts(String xPostmarkServerToken, String tag, Date fromdate, Date todate) Get email open counts
InlineResponse2002	getOutboundOpenCountsByEmailClient(String xPostmarkServerToken, String tag, Date fromdate, Date todate) Get email client usage
InlineResponse2003	getOutboundOpenCountsByPlatform(String xPostmarkServerToken, String tag, Date fromdate, Date todate) Get email platform usage
DynamicResponse	getOutboundOpenCountsByReadingTime(String xPostmarkServerToken, String tag, Date fromdate, Date todate) Get email read times
OutboundOverviewStatsResponse	getOutboundOverviewStatistics(String xPostmarkServerToken, String tag, Date fromdate, Date todate) Get outbound overview
SentCountsResponse	getSentCounts(String xPostmarkServerToken, String tag, Date fromdate, Date todate) Get sent counts
InlineResponse2004	getSpamComplaints(String xPostmarkServerToken, String tag, Date fromdate, Date todate) Get spam complaints
InlineResponse2005	getTrackedEmailCounts(String xPostmarkServerToken, String tag, Date fromdate, Date todate) Get tracked email counts
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StatsAPIApi

public StatsAPIApi()

StatsAPIApi

public StatsAPIApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getBounceCounts

public InlineResponse200 getBounceCounts(String xPostmarkServerToken,
                                         String tag,
                                         Date fromdate,
                                         Date todate)
                                  throws ApiException

Get bounce counts

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

tag - Filter by tag (optional)

fromdate - Filter stats starting from the date specified. e.g. `2014-01-01` (optional)

todate - Filter stats up to the date specified. e.g. `2014-02-01` (optional)

Returns:

InlineResponse200

Throws:

ApiException - if fails to make API call

getOutboundClickCounts

public DynamicResponse getOutboundClickCounts(String xPostmarkServerToken,
                                              String tag,
                                              Date fromdate,
                                              Date todate)
                                       throws ApiException

Get click counts

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

tag - Filter by tag (optional)

fromdate - Filter stats starting from the date specified. e.g. `2014-01-01` (optional)

todate - Filter stats up to the date specified. e.g. `2014-02-01` (optional)

Returns:

DynamicResponse

Throws:

ApiException - if fails to make API call

getOutboundClickCountsByBrowserFamily

public Object getOutboundClickCountsByBrowserFamily(String xPostmarkServerToken,
                                                    String tag,
                                                    Date fromdate,
                                                    Date todate)
                                             throws ApiException

Get browser usage by family

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

tag - Filter by tag (optional)

fromdate - Filter stats starting from the date specified. e.g. `2014-01-01` (optional)

todate - Filter stats up to the date specified. e.g. `2014-02-01` (optional)

Returns:

Object

Throws:

ApiException - if fails to make API call

getOutboundClickCountsByLocation

public DynamicResponse getOutboundClickCountsByLocation(String xPostmarkServerToken,
                                                        String tag,
                                                        Date fromdate,
                                                        Date todate)
                                                 throws ApiException

Get clicks by body location

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

tag - Filter by tag (optional)

fromdate - Filter stats starting from the date specified. e.g. `2014-01-01` (optional)

todate - Filter stats up to the date specified. e.g. `2014-02-01` (optional)

Returns:

DynamicResponse

Throws:

ApiException - if fails to make API call

getOutboundClickCountsByPlatform

public DynamicResponse getOutboundClickCountsByPlatform(String xPostmarkServerToken,
                                                        String tag,
                                                        Date fromdate,
                                                        Date todate)
                                                 throws ApiException

Get browser plaform usage

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

tag - Filter by tag (optional)

fromdate - Filter stats starting from the date specified. e.g. `2014-01-01` (optional)

todate - Filter stats up to the date specified. e.g. `2014-02-01` (optional)

Returns:

DynamicResponse

Throws:

ApiException - if fails to make API call

getOutboundOpenCounts

public InlineResponse2001 getOutboundOpenCounts(String xPostmarkServerToken,
                                                String tag,
                                                Date fromdate,
                                                Date todate)
                                         throws ApiException

Get email open counts

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

tag - Filter by tag (optional)

fromdate - Filter stats starting from the date specified. e.g. `2014-01-01` (optional)

todate - Filter stats up to the date specified. e.g. `2014-02-01` (optional)

Returns:

InlineResponse2001

Throws:

ApiException - if fails to make API call

getOutboundOpenCountsByEmailClient

public InlineResponse2002 getOutboundOpenCountsByEmailClient(String xPostmarkServerToken,
                                                             String tag,
                                                             Date fromdate,
                                                             Date todate)
                                                      throws ApiException

Get email client usage

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

tag - Filter by tag (optional)

fromdate - Filter stats starting from the date specified. e.g. `2014-01-01` (optional)

todate - Filter stats up to the date specified. e.g. `2014-02-01` (optional)

Returns:

InlineResponse2002

Throws:

ApiException - if fails to make API call

getOutboundOpenCountsByPlatform

public InlineResponse2003 getOutboundOpenCountsByPlatform(String xPostmarkServerToken,
                                                          String tag,
                                                          Date fromdate,
                                                          Date todate)
                                                   throws ApiException

Get email platform usage

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

tag - Filter by tag (optional)

fromdate - Filter stats starting from the date specified. e.g. `2014-01-01` (optional)

todate - Filter stats up to the date specified. e.g. `2014-02-01` (optional)

Returns:

InlineResponse2003

Throws:

ApiException - if fails to make API call

getOutboundOpenCountsByReadingTime

public DynamicResponse getOutboundOpenCountsByReadingTime(String xPostmarkServerToken,
                                                          String tag,
                                                          Date fromdate,
                                                          Date todate)
                                                   throws ApiException

Get email read times

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

tag - Filter by tag (optional)

fromdate - Filter stats starting from the date specified. e.g. `2014-01-01` (optional)

todate - Filter stats up to the date specified. e.g. `2014-02-01` (optional)

Returns:

DynamicResponse

Throws:

ApiException - if fails to make API call

getOutboundOverviewStatistics

public OutboundOverviewStatsResponse getOutboundOverviewStatistics(String xPostmarkServerToken,
                                                                   String tag,
                                                                   Date fromdate,
                                                                   Date todate)
                                                            throws ApiException

Get outbound overview

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

tag - Filter by tag (optional)

fromdate - Filter stats starting from the date specified. e.g. `2014-01-01` (optional)

todate - Filter stats up to the date specified. e.g. `2014-02-01` (optional)

Returns:

OutboundOverviewStatsResponse

Throws:

ApiException - if fails to make API call

getSentCounts

public SentCountsResponse getSentCounts(String xPostmarkServerToken,
                                        String tag,
                                        Date fromdate,
                                        Date todate)
                                 throws ApiException

Get sent counts

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

tag - Filter by tag (optional)

fromdate - Filter stats starting from the date specified. e.g. `2014-01-01` (optional)

todate - Filter stats up to the date specified. e.g. `2014-02-01` (optional)

Returns:

SentCountsResponse

Throws:

ApiException - if fails to make API call

getSpamComplaints

public InlineResponse2004 getSpamComplaints(String xPostmarkServerToken,
                                            String tag,
                                            Date fromdate,
                                            Date todate)
                                     throws ApiException

Get spam complaints

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

tag - Filter by tag (optional)

fromdate - Filter stats starting from the date specified. e.g. `2014-01-01` (optional)

todate - Filter stats up to the date specified. e.g. `2014-02-01` (optional)

Returns:

InlineResponse2004

Throws:

ApiException - if fails to make API call

getTrackedEmailCounts

public InlineResponse2005 getTrackedEmailCounts(String xPostmarkServerToken,
                                                String tag,
                                                Date fromdate,
                                                Date todate)
                                         throws ApiException

Get tracked email counts

Parameters:

xPostmarkServerToken - The token associated with the Server on which this request will operate. (required)

tag - Filter by tag (optional)

fromdate - Filter stats starting from the date specified. e.g. `2014-01-01` (optional)

todate - Filter stats starting from the date specified. e.g. `2014-01-01` (optional)

Returns:

InlineResponse2005

Throws:

ApiException - if fails to make API call