Overview

Namespaces

  • Apptus
    • ESales
      • Connector
        • Report
        • Time
    • Util
      • Cache
  • PHP

Classes

  • Ad
  • Ads
  • ArgMap
  • Attribute
  • AttributeValidation
  • Authorization
  • Category
  • CategoryData
  • CategoryList
  • CategoryNode
  • CloudConnector
  • ClusterUriIterator
  • Completion
  • Completions
  • CompressionMode
  • Connector
  • ConnectorSettingsBuilder
  • Correction
  • Corrections
  • Count
  • CssClass
  • CustomerKeyAuthentication
  • DynamicPage
  • EventDataJobResult
  • FacetList
  • FacetRange
  • Facets
  • Filter
  • FilterBuilder
  • ImportData
  • JavaScriptNotifier
  • MessageAuthentication
  • OnPremConnector
  • Order
  • OrderLine
  • Panel
  • PanelContent
  • Path
  • Phrase
  • Phrases
  • Product
  • Products
  • Reporter
  • ResultType
  • Session
  • Status
  • Subpanel
  • Value
  • Values
  • Variant

Interfaces

  • Facet
  • Result

Exceptions

  • BusyClusterException
  • ClusterUnavailableException
  • DuplicateSubpanelException
  • FetchClusterException
  • IOException
  • MalformedJsonException
  • MalformedURLException
  • MissingSubpanelException
  • PanelException
  • ParseException
  • ReportException
  • RequestFailedException
  • ResultTypeException
  • Overview
  • Namespace
  • Class
  • Tree

Class Reporter

A Reporter fetches market-specific reports from an eSales cluster.

All reports contains statistical data from a given time interval.

Namespace: Apptus\ESales\Connector
Located at Connector/Reporter.php
Methods summary
public
# setTimeZone( null|string|DateTimeZone $timeZone )

Sets the time zone.

Sets the time zone.

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).

The default time zone is

ini_get('date.timezone')

or

'UTC'

if

date.timezone

is not configured.

Parameters

$timeZone

string with the name of a supported timezone or a DateTimeZone object. Use null to set to default timezone.

Throws

InvalidArgumentException
if the given timezone is invalid.
public
# setLocale( null|string $locale )

Sets the locale.

Sets the locale.

A locale defines the beginning of a week and what week is the first of the year. 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 (en_US or de_DE).

The default locale depends on whether the intl extension is loaded or not. If it is loaded, locale defaults to a best guess of client locale based on the HTTP "Accept-Language" header or to the ini setting 'intl.default_locale' if the header is not sent. If the intl extension is not loaded, locale defaults to 'sv_SE' which use ISO 8601 standard week rules, i.e. week starts on Monday and the first week of the year has at least 4 days.

Parameters

$locale

string with the name of a locale. E.g. 'en_US' or 'sv_SE'. Use null to set to default.

public Apptus\ESales\Connector\Report\AdList
# adList( string $phrase, string $sortBy )

Fetches an Apptus\ESales\Connector\Report\AdList of ads that are active during the selected time range.

Fetches an Apptus\ESales\Connector\Report\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
phrase to incrementally find ads, all ad attributes will be used in the search.
$sortBy

sort by order for the ads.

       Available sort by values:
       <ul>
           <li>ad_key [asc|desc]</li>
           <li>ctr [asc|desc]</li>
           <li>conversion [asc|desc]</li>
           <li><i>any ad attribute</i> [asc|desc]</li>
       </ul>

Returns

Apptus\ESales\Connector\Report\AdList
An AdList containing ads with attributes, click through rate and conversion.

Throws

Apptus\ESales\Connector\ReportException
if there is a problem with fetching or parsing the report.
public Apptus\ESales\Connector\Report\AdConversionReport
# adConversion( array $adKeys, Apptus\ESales\Connector\Time\Duration $resolution )

Fetches an Apptus\ESales\Connector\Report\AdConversionReport for the ads specified as argument.

Fetches an Apptus\ESales\Connector\Report\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
ad keys to include in the report.
$resolution
resolution to use when the report is aggregated.

Returns

Apptus\ESales\Connector\Report\AdConversionReport
An AdConversionReport.

Throws

Apptus\ESales\Connector\ReportException
if there is a problem with fetching or parsing the report.
InvalidArgumentException
if there is a problem with the arguments.
public Apptus\ESales\Connector\Report\AdPlacementReport
# adPlacement( array $adKeys )

Fetches an Apptus\ESales\Connector\Report\AdPlacementReport for the ads specified as argument.

Fetches an Apptus\ESales\Connector\Report\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
ad keys to include in the report.

Returns

Apptus\ESales\Connector\Report\AdPlacementReport
An AdPlacementReport.

Throws

Apptus\ESales\Connector\ReportException
if there is a problem with fetching or parsing the report.
InvalidArgumentException
if there is a problem with the arguments.
public Apptus\ESales\Connector\Report\AdOrderValueReport
# adOrderValue( array $adKeys, Apptus\ESales\Connector\Report\TimelineType $timelineType )

Fetches an Apptus\ESales\Connector\Report\AdOrderValueReport for the ads specified as argument.

Fetches an Apptus\ESales\Connector\Report\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
ad keys to include in the report.
$timelineType
timeline type to use when the report is fetched.

Returns

Apptus\ESales\Connector\Report\AdOrderValueReport
An AdOrderValueReport.

Throws

Apptus\ESales\Connector\ReportException
if there is a problem with fetching or parsing the report.
InvalidArgumentException
if there is a problem with the arguments.
public Apptus\ESales\Connector\Report\PanelConversionReport
# panelConversion( string $panelPath )

Fetches a Apptus\ESales\Connector\Report\PanelConversionReport for the supplied panel and all of the sub panels.

Fetches a Apptus\ESales\Connector\Report\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 items added to cart that were later purchased or abandoned
  • Number of items added to cart that were later purchased
  • Click through rate
  • Adding to cart rate
  • Payment rate
  • Interest rate

Deprecated

For CloudConnector, please use apps. A PanelConversionReport.


Parameters

$panelPath
public panel path to fetch the report for.

Returns

Apptus\ESales\Connector\Report\PanelConversionReport

Throws

Apptus\ESales\Connector\ReportException
if there is a problem with fetching or parsing the report.
InvalidArgumentException
if there is a problem with the arguments.
public Apptus\ESales\Connector\Report\SessionStatisticsReport
# sessionStatistics( Apptus\ESales\Connector\Time\Duration $resolution )

Fetches a Apptus\ESales\Connector\Report\SessionStatisticsReport presented with the supplied resolution.

Fetches a Apptus\ESales\Connector\Report\SessionStatisticsReport presented with the supplied resolution.

The report contains a timeline of SessionStatistics

Parameters

$resolution
resolution to use when the report is aggregated.

Returns

Apptus\ESales\Connector\Report\SessionStatisticsReport
A SessionStatisticsReport.

Throws

Apptus\ESales\Connector\ReportException
if there is a problem with fetching or parsing the report.
public Apptus\ESales\Connector\Report\SessionSummaryReport
# sessionSummary( )

Fetches a Apptus\ESales\Connector\Report\SessionSummaryReport containing performance summary information for the whole site.

Fetches a Apptus\ESales\Connector\Report\SessionSummaryReport containing performance summary information for the whole site.

The summary contains:

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

Returns

Apptus\ESales\Connector\Report\SessionSummaryReport
A SessionSummaryReport.

Throws

Apptus\ESales\Connector\ReportException
if there is a problem with fetching or parsing the report.
public Apptus\ESales\Connector\Report\SearchStatisticsReport
# searchStatistics( )

Fetches a Apptus\ESales\Connector\Report\SearchStatisticsReport.

Fetches a Apptus\ESales\Connector\Report\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

Apptus\ESales\Connector\Report\SearchStatisticsReport
A SearchStatisticsReport.

Throws

Apptus\ESales\Connector\ReportException
if there is a problem with fetching or parsing of the report.
public Apptus\ESales\Connector\Report\ProductSalesByAttributeReport
# productSalesByAttribute( string|null $attribute, Apptus\ESales\Connector\Filter $filter, string|null $sortBy, Apptus\ESales\Connector\Facets $facets = null )

Fetches a Apptus\ESales\Connector\Report\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.

Fetches a Apptus\ESales\Connector\Report\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
filter attribute to find facet values for.
$filter
with facets, the set of products and variant to create the report for.
$sortBy

sort order for the report.

Available sort by values:

          <ul>
          <li>purchased_units [asc|desc]</li>
          <li>abandoned_units [asc|desc]</li>
          <li>discount [asc|desc]</li>
          <li>margin [asc|desc]</li>
          <li>revenue [asc|desc]</li>
          <li>attribute [asc|desc]</li>
          </ul>
$facets
with filter, the set of products and variant to create the report for. New since 3.7.0.

Returns

Apptus\ESales\Connector\Report\ProductSalesByAttributeReport
A Apptus\ESales\Connector\Report\ProductSalesByAttributeReport.

Throws

Apptus\ESales\Connector\ReportException
if there is a problem with fetching or parsing the report.

Since

3.4.0
public Apptus\ESales\Connector\Report\ProductSalesByTimeReport
# productSalesByTime( Apptus\ESales\Connector\Report\TimelineType $timelineType, Apptus\ESales\Connector\Filter $filter = null, Apptus\ESales\Connector\Facets $facets = null )

Fetches a Apptus\ESales\Connector\Report\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.

Fetches a Apptus\ESales\Connector\Report\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
timeline type to use for this report.
$filter
with Facets, the set of products and variant to create the report for.
$facets
with Filter, the set of products and variant to create the report for. New since 3.7.0

Returns

Apptus\ESales\Connector\Report\ProductSalesByTimeReport
A Apptus\ESales\Connector\Report\ProductSalesByTimeReport

Throws

Apptus\ESales\Connector\ReportException
if there is a problem with fetching or parsing of the report.

Since

3.4.0
public Apptus\ESales\Connector\Report\ProductTopSellersReport
# productTopSellers( Apptus\ESales\Connector\Filter $filter, string|null $sortBy, integer $windowFirst, integer $windowLast, Apptus\ESales\Connector\Facets $facets = null )

Fetches a Apptus\ESales\Connector\Report\ProductTopSellersReport. The report contains sales statistics for the best products and variants that matches the filter and 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.

Fetches a Apptus\ESales\Connector\Report\ProductTopSellersReport. The report contains sales statistics for the best products and variants that matches the filter and 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
with Facets, the set of products and variant to consider when the top list is created.
$sortBy

sort order for the report.

Available sort by values:

          <ul>
          <li>purchased_units [asc|desc]</li>
          <li>abandoned_units [asc|desc]</li>
          <li>discount [asc|desc]</li>
          <li>margin [asc|desc]</li>
          <li>revenue [asc|desc]</li>
          </ul>
$windowFirst
first position, inclusive, to be present in the report. The first position is 1.
$windowLast
last position, inclusive, to be present in the report.
$facets
with Filter, the set of products and variant to consider when the top list is created. New since 3.7.0

Returns

Apptus\ESales\Connector\Report\ProductTopSellersReport
A Apptus\ESales\Connector\Report\ProductTopSellersReport.

Throws

Apptus\ESales\Connector\ReportException
if there is a problem with fetching or parsing of the report.

Since

3.4.0
public Apptus\ESales\Connector\Report\TopSellingSearchesReport
# topSellingSearches( Apptus\ESales\Connector\Filter $filter, integer $windowFirst, integer $windowLast, Apptus\ESales\Connector\Facets $facets = null )

Fetches a Apptus\ESales\Connector\Report\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.

Fetches a Apptus\ESales\Connector\Report\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
with Facets, the set of products and variant to consider when the top list is created.
$windowFirst
first position, inclusive, to be present in the report. The first position is 1.
$windowLast
last position, inclusive, to be present in the report.
$facets
with Filter, the set of products and variant to consider when the top list is created. New since 3.7.0

Returns

Apptus\ESales\Connector\Report\TopSellingSearchesReport
A Apptus\ESales\Connector\Report\TopSellingSearchesReport.

Throws

Apptus\ESales\Connector\ReportException
if there is a problem with fetching or parsing of the report.

Since

3.5.0
Apptus ESales Connector PHP API documentation generated by ApiGen