com.elasticpath.cmweb.ajaxservice
Interface DashboardAjaxService

All Superinterfaces:

EpService

All Known Implementing Classes:

DashboardAjaxServiceImpl

public interface DashboardAjaxService
extends EpService

This service provides access to functionality and data (beans) for manipulating catalog objects on the Javascript client Dashboard (Home) page.

Method Summary

java.util.List	getCurrentMonthSalesStats(java.lang.String currencyCode) Get monthly sales stats -- an array of stats (# orders, #items, average items per order, average order value, revenue).
java.util.List	getCurrentWeekSalesStats(java.lang.String currencyCode) Get current week's sales stats -- an array of stats (# orders, #items, average items per order, average order value, revenue).
java.util.List	getCurrentYearSalesStats(java.lang.String currencyCode) Get current year's sales stats -- an array of stats (# orders, #items, average items per order, average order value, revenue).
java.util.List	getLastWeekSalesStats(java.lang.String currencyCode) Get sales stats for last week -- an array of stats (# orders, #items, average items per order, average order value, revenue).
java.util.Map	getQuickLinkStats() Get a map of order and promotion statistics, mapping from status (openOrders, holdOrders, activePromotions) to count.
java.util.Map	getStoreUsageStats() Get a map of store usage stats, mapping a period (day, lastDay, week, lastWeek, month, year) to an array of statistics (#registrations, #return customers, #new customers).
java.util.List	getTodaySalesStats(java.lang.String currencyCode) Get today's sales stats -- an array of stats (# orders, #items, average items per order, average order value, revenue).
java.util.List	getTopCategoriesStats(java.lang.String period, int maxResults) Get a list of the top selling leaf categories for the given time period.
java.util.List	getTopProductsStats(java.lang.String period, int maxResults) Get a list of the top selling products for the given time period.
java.util.List	getYesterdaySalesStats(java.lang.String currencyCode) Get yesterday's sales stats -- an array of stats (# orders, #items, average items per order, average order value, revenue).

Methods inherited from interface com.elasticpath.service.EpService

getElasticPath, setElasticPath

Method Detail

getCurrentMonthSalesStats

java.util.List getCurrentMonthSalesStats(java.lang.String currencyCode)

Get monthly sales stats -- an array of stats (# orders, #items, average items per order, average order value, revenue).

Parameters:

currencyCode - The currency code to calculate statistics for.

Returns:

an array of sales stats data.

getCurrentWeekSalesStats

java.util.List getCurrentWeekSalesStats(java.lang.String currencyCode)

Get current week's sales stats -- an array of stats (# orders, #items, average items per order, average order value, revenue).

Parameters:

currencyCode - The currency code to calculate statistics for.

Returns:

an array of sales stats data.

getCurrentYearSalesStats

java.util.List getCurrentYearSalesStats(java.lang.String currencyCode)

Get current year's sales stats -- an array of stats (# orders, #items, average items per order, average order value, revenue).

Parameters:

currencyCode - The currency code to calculate statistics for.

Returns:

an array of sales stats data.

getLastWeekSalesStats

java.util.List getLastWeekSalesStats(java.lang.String currencyCode)

Get sales stats for last week -- an array of stats (# orders, #items, average items per order, average order value, revenue).

Parameters:

currencyCode - The currency code to calculate statistics for.

Returns:

an array of sales stats data.

getQuickLinkStats

java.util.Map getQuickLinkStats()

Get a map of order and promotion statistics, mapping from status (openOrders, holdOrders, activePromotions) to count.

Returns:

Map of usage data.

getStoreUsageStats

java.util.Map getStoreUsageStats()

Get a map of store usage stats, mapping a period (day, lastDay, week, lastWeek, month, year) to an array of statistics (#registrations, #return customers, #new customers).

Returns:

Map of usage data.

getTodaySalesStats

java.util.List getTodaySalesStats(java.lang.String currencyCode)

Get today's sales stats -- an array of stats (# orders, #items, average items per order, average order value, revenue).

Parameters:

currencyCode - The currency code to calculate statistics for.

Returns:

an array of sales stats data.

getTopCategoriesStats

java.util.List getTopCategoriesStats(java.lang.String period,
                                     int maxResults)

Get a list of the top selling leaf categories for the given time period.

Parameters:

period - Time period to calculate for (day, lastDay, week, lastWeek, month, year).

maxResults - Number of top categories to return.

Returns:

List of size maxResults containing arrays Category Product Name and Sales Count.

getTopProductsStats

java.util.List getTopProductsStats(java.lang.String period,
                                   int maxResults)

Get a list of the top selling products for the given time period.

Parameters:

period - Time period to calculate for (day, lastDay, week, lastWeek, month, year).

maxResults - Number of top products to return.

Returns:

List of size maxResults containing arrays of Product Name and Sales Count.

getYesterdaySalesStats

java.util.List getYesterdaySalesStats(java.lang.String currencyCode)

Get yesterday's sales stats -- an array of stats (# orders, #items, average items per order, average order value, revenue).

Parameters:

currencyCode - The currency code to calculate statistics for.

Returns:

an array of sales stats data.