Reporter ClassA Sandcastle Documented Class Library
A Reporter fetches market-specific reports from an eSales cluster. All reports contains statistical data from a given time interval.
Inheritance Hierarchy

SystemObject
  Apptus.ESales.ConnectorReporter

Namespace:  Apptus.ESales.Connector
Assembly:  Apptus.Esales.ConnectorApi (in Apptus.Esales.ConnectorApi.dll) Version: 4.2.1
Syntax

C#
public class Reporter

The Reporter type exposes the following members.

Properties

  NameDescription
Public propertyCultureInfo
The culture. The default culture is
CultureInfo.CurrentCulture
. 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 culture specified.
Public propertyTimeZone
The time zone. The default value is the local GMT±hh:mm time zone, where hh:mm is the offset in hours and minutes from UTC at the start of the time interval. 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). See http://en.wikipedia.org/wiki/Tz_database for information about IANA time zones.
Top
Methods

  NameDescription
Public methodAdConversion
Fetches a report for conversion rates of ads.
Public methodAdList
Fetches a list of valid ads. The list can be filtered by a search phrase and allows different sort orders to be applied.
Public methodAdOrderValue
Fetches a report for order values associated with ads.
Public methodAdPlacement
Fetches a report for placements of ads.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodPanelConversion Obsolete.
Fetches a report for conversion rates for panels.
Public methodProductSalesByAttribute(String, Filter, String)
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.
Public methodProductSalesByAttribute(String, Filter, Facets, String)
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.
Public methodProductSalesByTime
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.
Public methodProductTopSellers(Filter, String, Int32, Int32)
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.
Public methodProductTopSellers(Filter, Facets, String, Int32, Int32)
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.
Public methodSearchStatistics
Fetches a report for search phrase statistics.
Public methodSessionStatistics
Fetches a report for statistics of visits (sessions).
Public methodSessionSummary
Fetches a report with a summary of statistics for visits (sessions).
Public methodTopSellingSearches(Filter, Int32, Int32)
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.

Public methodTopSellingSearches(Filter, Facets, Int32, Int32)
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.

Public methodToString (Inherited from Object.)
Top
See Also

Reference