Package com.mailersend.sdk.analytics

Class Analytics

java.lang.Object

com.mailersend.sdk.analytics.Analytics

public class Analytics
extends Object

Analytics class.

Version:

$Id: $Id

Author:

mailersend

Constructor Summary

Constructors

Constructor	Description
Analytics(MailerSend ref)	Do not initialize directly.

Method Summary

Modifier and Type	Method	Description
Analytics	dateFrom(Date dateFrom)	Sets the date from filter for the request
Analytics	dateTo(Date dateTo)	Sets the date to filter for the request
Analytics	domainId(String domainId)	Sets the domain id for the request
AnalyticsByDateList	getByDate(String[] events)	Gets the analytics by date
AnalyticsByDateList	getByDate(String groupBy, String[] events)	Gets the analytics by date
AnalyticsList	getOpensByCountry()	Gets the opens by country
AnalyticsList	getOpensByUserAgent()	Gets the opens by user agent
AnalyticsList	getOpensByUserAgenType()	Gets the opens by the user agent type (by reading environment)
Analytics	tag(String tag)	Adds a tag filter to the request
Analytics	tags(String[] tags)	Sets the tags filters for the request

Methods inherited from class java.lang.Object

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

Constructor Detail

Analytics

public Analytics(MailerSend ref)

Do not initialize directly. This should only be accessed from MailerSend.analytics

Parameters:

ref - a MailerSend object.

Method Detail

domainId

public Analytics domainId(String domainId)

Sets the domain id for the request

Parameters:

domainId - a String object.

Returns:

a Analytics object.

dateFrom

public Analytics dateFrom(Date dateFrom)

Sets the date from filter for the request

Parameters:

dateFrom - a Date object.

Returns:

a Analytics object.

dateTo

public Analytics dateTo(Date dateTo)

Sets the date to filter for the request

Parameters:

dateTo - a Date object.

Returns:

a Analytics object.

tags

public Analytics tags(String[] tags)

Sets the tags filters for the request

Parameters:

tags - an array of String objects.

Returns:

a Analytics object.

tag

public Analytics tag(String tag)

Adds a tag filter to the request

Parameters:

tag - a String object.

Returns:

a Analytics object.

getByDate

public AnalyticsByDateList getByDate(String[] events)
                              throws MailerSendException

Gets the analytics by date

Parameters:

events - an array of String objects.

Returns:

a AnalyticsByDateList object.

Throws:

MailerSendException

getByDate

public AnalyticsByDateList getByDate(String groupBy,
                                     String[] events)
                              throws MailerSendException

Gets the analytics by date

Parameters:

groupBy - a String object.

events - an array of String objects.

Returns:

a AnalyticsByDateList object.

Throws:

MailerSendException

getOpensByCountry

public AnalyticsList getOpensByCountry()
                                throws MailerSendException

Gets the opens by country

Returns:

a AnalyticsList object.

Throws:

MailerSendException

getOpensByUserAgent

public AnalyticsList getOpensByUserAgent()
                                  throws MailerSendException

Gets the opens by user agent

Returns:

a AnalyticsList object.

Throws:

MailerSendException

getOpensByUserAgenType

public AnalyticsList getOpensByUserAgenType()
                                     throws MailerSendException

Gets the opens by the user agent type (by reading environment)

Returns:

a AnalyticsList object.

Throws:

MailerSendException