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 SearchStatisticsReport

Report for Search statistics on the site.

This report can be seen in the Search Statistics tab on the Reports page in eSales Manager and it is described in the Search statistics section on Apptus Zone (http://zone.apptus.com).

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

Creates an SearchStatisticsReport from an XML document.

Creates an SearchStatisticsReport 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\Rate $searchesWithHitsRate, array $searchesWithHits, Apptus\ESales\Connector\Report\Rate $searchesWithNoHitsRate, array $searchesWithNoHits, array $searchesThatBoost, array $searchesThatLower, DateTimeZone $tz )

Creates a SearchStatisticsReport.

Creates a SearchStatisticsReport.

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.
$searchesWithHitsRate
rate of searches that leads to at least one hit.
$searchesWithHits
of the most popular search phrases that has resulted in search hits.
$searchesWithNoHitsRate
rate of searches that does not lead to a no hit.
$searchesWithNoHits
of the most popular search phrases that has resulted in no hits.
$searchesThatBoost
of the search phrases that has largest positive impact on the conversion.
$searchesThatLower
of the search phrases that has largest negative impact on the conversion.
$tz
time zone for this report.
public array
# searchesWithHits( )

Returns

array
List of the most popular search phrases that has resulted in search hits.
public Apptus\ESales\Connector\Report\Rate
# searchesWithHitsTotalRate( )

Returns

Apptus\ESales\Connector\Report\Rate
The rate of searches that leads to at least one hit or Rate::NaN() if the rate can not be calculated.
public array
# searchesWithNoHits( )

Returns

array
List of the most popular search phrases that has resulted in no hits or Rate::NaN() if the rate can not be calculated.
public Apptus\ESales\Connector\Report\Rate
# searchesWithNoHitsTotalRate( )

Returns

Apptus\ESales\Connector\Report\Rate
The rate of searches that does not lead to a no hit.
public array
# searchesThatBoostConversion( )

Returns

array
List of the search phrases that has largest positive impact on the conversion.
public array
# searchesThatLowerConversion( )

Returns

array
List of the search phrases that has largest negative impact on the conversion.
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