Package com.apptus.esales.connector

Class Reporter

java.lang.Object

com.apptus.esales.connector.Reporter

public class Reporter
extends Object

A Reporter fetches market-specific reports from an eSales cluster. All reports contains statistical data from a given time interval.

Author:

Robert Åkemalm, Thomas Raneland

Method Summary

Modifier and Type	Method	Description
AdConversionReport	adConversion(List<String> adKeys, Duration resolution)	Fetches an AdConversionReport for the ads specified as argument.
AdList	adList(String phrase, String sortBy)	Fetches an AdList of ads that are active during the selected time range.
AdOrderValueReport	adOrderValue(List<String> adKeys, TimelineType<?> timelineType)	Fetches an AdOrderValueReport for the ads specified as argument.
AdPlacementReport	adPlacement(List<String> adKeys)	Fetches an AdPlacementReport for the ads specified as argument.
PanelConversionReport	panelConversion(String panelPath)	Deprecated. For CloudConnector, please use the apps.
ProductSalesByAttributeReport	productSalesByAttribute(String attribute, Filter filter, Facets facets, String sortBy)	Fetches a ProductSalesByAttributeReport.
ProductSalesByAttributeReport	productSalesByAttribute(String attribute, Filter filter, String sortBy)	Fetches a ProductSalesByAttributeReport.
ProductSalesByTimeReport	productSalesByTime(TimelineType<?> timelineType, Filter filter)	Fetches a ProductSalesByTimeReport.
ProductSalesByTimeReport	productSalesByTime(TimelineType<?> timelineType, Filter filter, Facets facets)	Fetches a ProductSalesByTimeReport.
ProductTopSellersReport	productTopSellers(Filter filter, Facets facets, String sortBy, int windowFirst, int windowLast)	Fetches a ProductTopSellersReport.
ProductTopSellersReport	productTopSellers(Filter filter, String sortBy, int windowFirst, int windowLast)	Fetches a ProductTopSellersReport.
SearchStatisticsReport	searchStatistics()	Fetches an SearchStatisticsReport.
SessionStatisticsReport	sessionStatistics(Duration resolution)	Fetches an SessionStatisticsReport presented with the supplied resolution.
SessionSummaryReport	sessionSummary()	Fetches an SessionSummaryReport containing performance summary information for the whole site.
void	setLocale(Locale locale)	Sets the locale.
void	setTimeZone(TimeZone timeZone)	Sets the time zone.
TopSellingSearchesReport	topSellingSearches(Filter filter, int windowFirst, int windowLast)	Fetches a TopSellingSearchesReport.
TopSellingSearchesReport	topSellingSearches(Filter filter, Facets facets, int windowFirst, int windowLast)	Fetches a TopSellingSearchesReport.

Methods inherited from class java.lang.Object

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

Method Detail

setTimeZone

public void setTimeZone(TimeZone timeZone)

Sets the time zone. The default time zone is TimeZone.getDefault().

A time zone defines the beginning of a day. For instance, Sunday 23:30 GMT (London) is the same time as Monday 00:30 GMT+01 (Berlin). Events from that time may be included in statistics for Sunday or Monday, depending on the time zone specified (Europe/London or Europe/Berlin).

Parameters:

timeZone - a new time zone

See Also:

TimeZone

setLocale

public void setLocale(Locale locale)

Sets the locale. The default locale is Locale.getDefault().

A locale defines the beginning of a week. For instance, in the U.S., the week starts on Sunday, while in Germany, it starts on Monday. Events from a Sunday may be included in different weeks, depending on the locale specified (Locale.US or Locale.GERMANY).

Parameters:

locale - a new locale

See Also:

Locale

adList

public AdList adList(String phrase,
                     String sortBy)
              throws ReportException

Fetches an AdList of ads that are active during the selected time range. All attributes for the ads are available in the report together with click through rate and conversion rate. The ads in the report are selected by an incremental search and sorted according to the supplied sortBy and locale arguments.

Parameters:

phrase - The phrase to incrementally find ads, all ad attributes will be used in the search.

sortBy - The sort by order for the ads.

Available sort by values:

• ad_key [asc|desc]
• ctr [asc|desc]
• conversion [asc|desc]
• any ad attribute [asc|desc]

Returns:

An AdList containing ads with attributes, click through rate and conversion.

Throws:

ReportException - if there is a problem with fetching or parsing of the report.

adConversion

public AdConversionReport adConversion(List<String> adKeys,
                                       Duration resolution)
                                throws ReportException

Fetches an AdConversionReport for the ads specified as argument. The report contains one section for each ad and each sections contains the following information:

• All attributes for the ad
• A timeline with conversion rate for visits that has seen the ad
• A timeline with conversion rate for visits that has not seen the ad
• A timeline with conversion rate for the campaign that the ad is part of
• An average conversion rate for the campaign that the ad is part of

Parameters:

adKeys - The ad keys to include in the report.

resolution - The resolution to use when the report is aggregated.

Returns:

An AdConversionReport.

Throws:

ReportException - if there is a problem with fetching or parsing of the report.

adPlacement

public AdPlacementReport adPlacement(List<String> adKeys)
                              throws ReportException

Fetches an AdPlacementReport for the ads specified as argument. The report contains one section for each ad and each sections contains the following information:

• All attributes for the ad
• A list of Placement containing click, display, click through rate and path information for where the ad has been displayed

Parameters:

adKeys - The ad keys to include in the report.

Returns:

An AdPlacementReport.

Throws:

ReportException - if there is a problem with fetching or parsing of the report.

adOrderValue

public AdOrderValueReport adOrderValue(List<String> adKeys,
                                       TimelineType<?> timelineType)
                                throws ReportException

Fetches an AdOrderValueReport for the ads specified as argument. The report contains one section for each ad and each sections contains the following information:

• All attributes for the ad
• A timeline with click through rate for the ad
• A timeline with average order value for the ad

Parameters:

adKeys - The ad keys to include in the report.

timelineType - The timeline type to use in the report.

Returns:

An AdOrderValueReport.

Throws:

ReportException - if there is a problem with fetching or parsing of the report.

panelConversion

@Deprecated
public PanelConversionReport panelConversion(String panelPath)
                                      throws ReportException

Deprecated.

For CloudConnector, please use the apps.

Fetches an PanelConversionReport for the supplied panel and all of the sub panels. The report contains one section for each public panel path, sorted alphabetically, and each sections contains the following information:

• Number of displays
• Number of clicks
• Number of add to carts
• Number of add to carts on items that were later purchased
• Click through rate
• Adding to cart rate
• Payment rate
• Interest rate
• Total revenue generated
• Total units sold

Parameters:

panelPath - The public panel path to fetch the report for.

Returns:

A PanelConversionReport.

Throws:

ReportException - if there is a problem with fetching or parsing of the report.

sessionStatistics

public SessionStatisticsReport sessionStatistics(Duration resolution)
                                          throws ReportException

Fetches an SessionStatisticsReport presented with the supplied resolution. The report contains a timeline of SessionStatistics

Parameters:

resolution - The resolution to use when the report is aggregated.

Returns:

A SessionStatisticsReport.

Throws:

ReportException - if there is a problem with fetching or parsing of the report.

sessionSummary

public SessionSummaryReport sessionSummary()
                                    throws ReportException

Fetches an SessionSummaryReport containing performance summary information for the whole site. The summary contains:

• Number of visits
• Bounce rate
• Number of orders
• Conversion rate

Returns:

A SessionSummaryReport

Throws:

ReportException - if there is a problem with fetching or parsing of the report.

searchStatistics

public SearchStatisticsReport searchStatistics()
                                        throws ReportException

Fetches an SearchStatisticsReport. The report contains;

• A ratio for the number of searches that results in a hit.
• A ratio for the number of searches that results in a no hit.
• A list of the 100 most popular search phrases that results in a hit.
• A list of the 100 most popular search phrases that results in a no hit.
• A list of the 100 search phrases with the highest positive impact on the total conversion rate.
• A list of the 100 search phrases with the highest negative impact on the total conversion rate.

Returns:

A SearchStatisticsReport.

Throws:

ReportException - if there is a problem with fetching or parsing of the report.

productSalesByAttribute

public ProductSalesByAttributeReport productSalesByAttribute(String attribute,
                                                             Filter filter,
                                                             String sortBy)
                                                      throws ReportException

Fetches a ProductSalesByAttributeReport. The report is aggregated by facet values for the given attribute or a summary if the attribute is null.

The report contains a section for each facet value. Each section contains:

• Name of the facet value.
• The total number of purchased products and variants that has this facet value and matches the filter.
• The total number of abandoned products and variants that has this facet value and matches the filter.
• The total discount for the products and variants that has this facet value and matches the filter.
• The total margin for the products and variants that has this facet value and matches the filter.
• The total revenue for the products and variants that has this facet value and matches the filter.

Parameters:

attribute - The filter attribute to find facet values for.

filter - The set of products and variant to create the report for.

sortBy - The sort order for the report.

Available sort by values:

• purchased_units [asc|desc]
• abandoned_units [asc|desc]
• discount [asc|desc]
• margin [asc|desc]
• revenue [asc|desc]
• attribute [asc|desc]

Returns:

A ProductSalesByAttributeReport

Throws:

ReportException - if there is a problem with fetching or parsing of the report.

Since:

3.4.0

productSalesByAttribute

public ProductSalesByAttributeReport productSalesByAttribute(String attribute,
                                                             Filter filter,
                                                             Facets facets,
                                                             String sortBy)
                                                      throws ReportException

Fetches a ProductSalesByAttributeReport. The report is aggregated by facet values for the given attribute or a summary if the attribute is null.

The report contains a section for each facet value. Each section contains:

• Name of the facet value.
• The total number of purchased products and variants that has this facet value and matches the filter and the facets filter.
• The total number of abandoned products and variants that has this facet value and matches the filter and the facets filter.
• The total discount for the products and variants that has this facet value and matches the filter and the facets filter.
• The total margin for the products and variants that has this facet value and matches the filter and the facets filter.
• The total revenue for the products and variants that has this facet value and matches the filter and the facets filter.

Parameters:

attribute - The filter attribute to find facet values for.

filter - Together with facets, the set of products and variant to create the report for.

facets - Together with filter, the set of products and variant to create the report for.

sortBy - The sort order for the report.

Available sort by values:

• purchased_units [asc|desc]
• abandoned_units [asc|desc]
• discount [asc|desc]
• margin [asc|desc]
• revenue [asc|desc]
• attribute [asc|desc]

Returns:

A ProductSalesByAttributeReport

Throws:

ReportException - if there is a problem with fetching or parsing of the report.

Since:

3.7.0

productSalesByTime

public ProductSalesByTimeReport productSalesByTime(TimelineType<?> timelineType,
                                                   Filter filter)
                                            throws ReportException

Fetches a ProductSalesByTimeReport. The report contains sales statistics aggregated according to the supplied timeline type. The report aggregates data for all products and variant that matches the filter.

The report contains timelines for the following metrics:

• The number of purchased products and variants purchased during the timeslot.
• The number of abandoned products and variants abandoned during the timeslot
• The discount for the products and variants purchased during the timeslot.
• The margin for the products and variants purchased during the timeslot.
• The revenue for the products and variants purchased during the timeslot.

Parameters:

timelineType - The timeline type to use for this report.

filter - The set of products and variant to create the report for.

Returns:

A ProductSalesByTimeReport

Throws:

ReportException - if there is a problem with fetching or parsing of the report.

Since:

3.4.0

productSalesByTime

public ProductSalesByTimeReport productSalesByTime(TimelineType<?> timelineType,
                                                   Filter filter,
                                                   Facets facets)
                                            throws ReportException

Fetches a ProductSalesByTimeReport. The report contains sales statistics aggregated according to the supplied timeline type. The report aggregates data for all products and variant that matches the filter and the facets.

The report contains timelines for the following metrics:

• The number of purchased products and variants purchased during the timeslot.
• The number of abandoned products and variants abandoned during the timeslot
• The discount for the products and variants purchased during the timeslot.
• The margin for the products and variants purchased during the timeslot.
• The revenue for the products and variants purchased during the timeslot.

Parameters:

timelineType - The timeline type to use for this report.

filter - Together with facets, the set of products and variant to create the report for.

facets - Together with filter, the set of products and variant to create the report for.

Returns:

A ProductSalesByTimeReport

Throws:

ReportException - if there is a problem with fetching or parsing of the report.

Since:

3.7.0

productTopSellers

public ProductTopSellersReport productTopSellers(Filter filter,
                                                 String sortBy,
                                                 int windowFirst,
                                                 int windowLast)
                                          throws ReportException

Fetches a ProductTopSellersReport. The report contains sales statistics for the best products and variants that matches the filter. The report is sorted according to the specified sort by order.

The report contains a list of sections, each containing the following values:

• The product key.
• The variant key or an empty String if it is a product.
• The number of purchases during the time interval.
• The number of abandonment during the time interval.
• The total discount for the item during the time interval.
• The total margin for the item during the time interval.
• The total revenue for the item during the time interval.

Parameters:

filter - The set of products and variant to consider when the top list is created.

sortBy - The sort order for the report.

Available sort by values:

• purchased_units [asc|desc]
• abandoned_units [asc|desc]
• discount [asc|desc]
• margin [asc|desc]
• revenue [asc|desc]

windowFirst - The first position, inclusive, to be present in the report. The first position is 1.

windowLast - The last position, inclusive, to be present in the report.

Returns:

A ProductTopSellersReport

Throws:

ReportException - if there is a problem with fetching or parsing of the report.

Since:

3.4.0

productTopSellers

public ProductTopSellersReport productTopSellers(Filter filter,
                                                 Facets facets,
                                                 String sortBy,
                                                 int windowFirst,
                                                 int windowLast)
                                          throws ReportException

Fetches a ProductTopSellersReport. The report contains sales statistics for the best products and variants that matches the filter and the facets. The report is sorted according to the specified sort by order.

The report contains a list of sections, each containing the following values:

• The product key.
• The variant key or an empty String if it is a product.
• The number of purchases during the time interval.
• The number of abandonment during the time interval.
• The total discount for the item during the time interval.
• The total margin for the item during the time interval.
• The total revenue for the item during the time interval.

Parameters:

filter - Together with facets, the set of products and variant to consider when the top list is created.

facets - Together with filter, the set of products and variant to consider when the top list is created.

sortBy - The sort order for the report.

Available sort by values:

• purchased_units [asc|desc]
• abandoned_units [asc|desc]
• discount [asc|desc]
• margin [asc|desc]
• revenue [asc|desc]

windowFirst - The first position, inclusive, to be present in the report. The first position is 1.

windowLast - The last position, inclusive, to be present in the report.

Returns:

A ProductTopSellersReport

Throws:

ReportException - if there is a problem with fetching or parsing of the report.

Since:

3.7.0

topSellingSearches

public TopSellingSearchesReport topSellingSearches(Filter filter,
                                                   int windowFirst,
                                                   int windowLast)
                                            throws ReportException

Fetches a TopSellingSearchesReport. The report contains a top list of search phrases associated with the products and variants that matches the filter. The report is sorted by the total number of purchases, of products and variants that matches the filter, that the search phrases can be associated with.

The report contains a list of sections, each containing a search phrase and the number of times the search phrase has lead to a purchase of a product or variant that matches the filter.

Parameters:

filter - The set of products and variant to consider when the top list is created.

windowFirst - The first position, inclusive, to be present in the report. The first position is 1.

windowLast - The last position, inclusive, to be present in the report.

Returns:

A TopSellingSearchesReport

Throws:

ReportException - if there is a problem with fetching or parsing of the report.

Since:

3.5.0

topSellingSearches

public TopSellingSearchesReport topSellingSearches(Filter filter,
                                                   Facets facets,
                                                   int windowFirst,
                                                   int windowLast)
                                            throws ReportException

Fetches a TopSellingSearchesReport. The report contains a top list of search phrases associated with the products and variants that matches the filter and the facets. The report is sorted by the total number of purchases, of products and variants that matches the filter and the facets, that the search phrases can be associated with.

The report contains a list of sections, each containing a search phrase and the number of times the search phrase has lead to a purchase of a product or variant that matches the filter and the facets.

Parameters:

filter - Together with facets, the set of products and variant to consider when the top list is created.

facets - Together with filter, the set of products and variant to consider when the top list is created.

windowFirst - The first position, inclusive, to be present in the report. The first position is 1.

windowLast - The last position, inclusive, to be present in the report.

Returns:

A TopSellingSearchesReport

Throws:

ReportException - if there is a problem with fetching or parsing of the report.

Since:

3.7.0