Overview

Namespaces

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

Classes

  • Ad
  • AdConversionReport
  • AdConversionReportSection
  • AdList
  • AdListSection
  • AdOrderValueReport
  • AdOrderValueReportSection
  • AdPlacementReport
  • AdPlacementReportSection
  • Attribute
  • PanelConversionReport
  • PanelConversionReportSection
  • Placement
  • ProductSalesByAttributeReport
  • ProductSalesByAttributeReportSection
  • ProductSalesByTimeReport
  • ProductTopSellersReport
  • ProductTopSellersReportSection
  • Rate
  • Report
  • SearchConversion
  • SearchCount
  • SearchStatisticsReport
  • SessionStatistics
  • SessionStatisticsReport
  • SessionSummaryReport
  • Summary
  • Timeline
  • TimelineType
  • TimeSlot
  • TopSellingSearchesReport
  • TopSellingSearchesReportSection

Exceptions

  • FormatException
  • Overview
  • Namespace
  • Class
  • Tree

Class SessionSummaryReport

Report with a summary of session statistics for the entire site as well as grouped by searches and recommendations.

This report can be seen at the top of the Site Summary tab on the Reports page in eSales Manager and it is described in the Session summary section on Apptus Zone (http://zone.apptus.com).

Apptus\ESales\Connector\Report\Report
Extended by Apptus\ESales\Connector\Report\SessionSummaryReport
Namespace: Apptus\ESales\Connector\Report
Located at Connector/Report/SessionSummaryReport.php
Methods summary
public static Apptus\ESales\Connector\Report\AdPlacementReport
# parse( string $data, DateTimeZone $tz )

Creates an SessionSummaryReport from an XML document.

Creates an SessionSummaryReport from an XML document.

Parameters

$data
string with the XML document to parse.
$tz
time zone for this report.

Returns

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

Throws

Apptus\ESales\Connector\Report\FormatException
if the XML document does not match the expected format.
public
# __construct( SimpleXMLElement $asXml, Apptus\ESales\Connector\Time\TimeInterval $interval, Apptus\ESales\Connector\Report\Summary $site, Apptus\ESales\Connector\Report\Summary $search, Apptus\ESales\Connector\Report\Summary $recommendation, DateTimeZone $tz )

Creates an SessionSummaryReport. Note that null is illegal for all input parameters.

Creates an SessionSummaryReport. Note that null is illegal for all input parameters.

Parameters

$asXml
XmlTree to be used if the Apptus\ESales\Connector\Report\Report::exportToXml() method is called.
$interval
time range for the data in this report.
$site
summary containing bounce rate, number of visits, number of orders and conversion rate for the site.
$search
summary containing number of visits, number of orders and conversion rate for the search panels.
$recommendation
summary containing number of visits, number of orders and conversion rate for the recommendation panels.
$tz
time zone for the data in this report.
public Apptus\ESales\Connector\Report\Summary
# site( )

Returns

Apptus\ESales\Connector\Report\Summary
A summary containing bounce rate, number of visits, number of orders and conversion rate for the site.
public Apptus\ESales\Connector\Report\Summary
# search( )

Returns

Apptus\ESales\Connector\Report\Summary
A summary containing number of visits, number of orders and conversion rate for the search panels.
public Apptus\ESales\Connector\Report\Summary
# recommendation( )

Returns

Apptus\ESales\Connector\Report\Summary
A summary containing number of visits, number of orders and conversion rate for the recommendation panels.
public
# exportToExcel( string $file )

Writes the report to a file. The report is written in plain text and ';' is used as separator.

Writes the report to a file. The report is written in plain text and ';' is used as separator.

Parameters

$file
file to write the report to.
Methods inherited from Apptus\ESales\Connector\Report\Report
exportToXml(), timeInterval()
Apptus ESales Connector PHP API documentation generated by ApiGen