• Home
• Piwik
• Plugins
• Actions
• API

PHP Class Piwik\Plugins\Actions\API

For example, "getPageTitles" will return all your page titles along with standard Actions metrics for each row. It is also possible to request data for a specific Page Title with "getPageTitle" and setting the parameter pageName to the page title you wish to request. Similarly, you can request metrics for a given Page URL via "getPageUrl", a Download file via "getDownload" and an outlink via "getOutlink". Note: pageName, pageUrl, outlinkUrl, downloadUrl parameters must be URL encoded before you call the API. Show file Open project: piwik/piwik Class Usage Examples

Public Methods

Method	Description
get ( integer $idSite, string $period, string $date, boolean | string $segment = false, boolean | array $columns = false ) : DataTable	Returns the list of metrics (pages, downloads, outlinks)
getDownload ( $downloadUrl, $idSite, $period, $date, $segment = false )
getDownloads ( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false, $flat = false )
getEntryPageTitles ( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false )	Returns a DataTable with analytics information for every unique entry page title for the given site, time period & segment.
getEntryPageUrls ( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false )	Returns a DataTable with analytics information for every unique entry page URL, for the specified site, period & segment.
getExitPageTitles ( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false )	Returns a DataTable with analytics information for every unique exit page title for the given site, time period & segment.
getExitPageUrls ( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false )	Returns a DataTable with analytics information for every unique exit page URL, for the specified site, period & segment.
getOutlink ( $outlinkUrl, $idSite, $period, $date, $segment = false )
getOutlinks ( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false, $flat = false )
getPageTitle ( $pageName, $idSite, $period, $date, $segment = false )
getPageTitles ( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false, $flat = false )
getPageTitlesFollowingSiteSearch ( integer $idSite, string $period, Date $date, boolean $segment = false, boolean $expanded = false, boolean $idSubtable = false ) : DataTable | Piwik\DataTable\Map
getPageUrl ( $pageUrl, $idSite, $period, $date, $segment = false )
getPageUrls ( integer $idSite, string $period, Date $date, boolean $segment = false, boolean $expanded = false, boolean | integer $idSubtable = false, boolean | integer $depth = false, boolean | integer $flat = false ) : DataTable | Piwik\DataTable\Map
getPageUrlsFollowingSiteSearch ( integer $idSite, string $period, Date $date, boolean $segment = false, boolean $expanded = false, boolean $idSubtable = false ) : DataTable | Piwik\DataTable\Map
getSiteSearchCategories ( integer $idSite, string $period, Date $date, boolean $segment = false ) : DataTable | Piwik\DataTable\Map
getSiteSearchKeywords ( $idSite, $period, $date, $segment = false )
getSiteSearchNoResultKeywords ( $idSite, $period, $date, $segment = false )

Protected Methods

Method	Description
addPagesPerSearchColumn ( DataTable | Piwik\DataTable\Simple | Piwik\DataTable\Map $dataTable, string $columnToRead = 'nb_hits' )	Visitors can search, and then click "next" to view more results. This is the average number of search results pages viewed for this keyword.
doFilterPageDatatableSearch ( $callBackParameters, $table, $searchTree )	This looks very similar to LabelFilter.php should it be refactored somehow? FIXME
getFilterPageDatatableSearch ( $callBackParameters, $search, $actionType, $table = false, $searchTree = false )	Will search in the DataTable for a Label matching the searched string and return only the matching row, or an empty datatable
getSiteSearchKeywordsRaw ( $idSite, $period, $date, $segment )
keepPagesFollowingSearch ( DataTable $dataTable )

Private Methods

Method	Description
addPageProcessedMetrics ( Piwik\DataTable\DataTableInterface $dataTable )
filterActionsDataTable ( DataTable | Piwik\DataTable\Simple | Piwik\DataTable\Map $dataTable )	Common filters for all Actions API
filterNonEntryActions ( DataTable $dataTable )	Removes DataTable rows referencing actions that were never the first action of a visit.
filterNonExitActions ( DataTable $dataTable )	Removes DataTable rows referencing actions that were never the last action of a visit.

Method Details