PHP 클래스 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.
상속: extends Piwik\Plugin\API
파일 보기 프로젝트 열기: piwik/piwik 1 사용 예제들

공개 메소드들

메소드 설명
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 )

보호된 메소드들

메소드 설명
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 )

비공개 메소드들

메소드 설명
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.

메소드 상세

addPagesPerSearchColumn() 보호된 메소드

Visitors can search, and then click "next" to view more results. This is the average number of search results pages viewed for this keyword.
protected addPagesPerSearchColumn ( DataTable | Piwik\DataTable\Simple | Piwik\DataTable\Map $dataTable, string $columnToRead = 'nb_hits' )
$dataTable Piwik\DataTable | Piwik\DataTable\Simple | Piwik\DataTable\Map
$columnToRead string

doFilterPageDatatableSearch() 보호된 메소드

This looks very similar to LabelFilter.php should it be refactored somehow? FIXME
protected doFilterPageDatatableSearch ( $callBackParameters, $table, $searchTree )

get() 공개 메소드

Returns the list of metrics (pages, downloads, outlinks)
public get ( integer $idSite, string $period, string $date, boolean | string $segment = false, boolean | array $columns = false ) : DataTable
$idSite integer
$period string
$date string
$segment boolean | string
$columns boolean | array
리턴 Piwik\DataTable

getDownload() 공개 메소드

public getDownload ( $downloadUrl, $idSite, $period, $date, $segment = false )

getDownloads() 공개 메소드

public getDownloads ( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false, $flat = false )

getEntryPageTitles() 공개 메소드

Returns a DataTable with analytics information for every unique entry page title for the given site, time period & segment.
public getEntryPageTitles ( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false )

getEntryPageUrls() 공개 메소드

Returns a DataTable with analytics information for every unique entry page URL, for the specified site, period & segment.
public getEntryPageUrls ( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false )

getExitPageTitles() 공개 메소드

Returns a DataTable with analytics information for every unique exit page title for the given site, time period & segment.
public getExitPageTitles ( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false )

getExitPageUrls() 공개 메소드

Returns a DataTable with analytics information for every unique exit page URL, for the specified site, period & segment.
public getExitPageUrls ( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false )

getFilterPageDatatableSearch() 보호된 메소드

Will search in the DataTable for a Label matching the searched string and return only the matching row, or an empty datatable
protected getFilterPageDatatableSearch ( $callBackParameters, $search, $actionType, $table = false, $searchTree = false )

getPageTitle() 공개 메소드

public getPageTitle ( $pageName, $idSite, $period, $date, $segment = false )

getPageTitles() 공개 메소드

public getPageTitles ( $idSite, $period, $date, $segment = false, $expanded = false, $idSubtable = false, $flat = false )

getPageTitlesFollowingSiteSearch() 공개 메소드

public getPageTitlesFollowingSiteSearch ( integer $idSite, string $period, Date $date, boolean $segment = false, boolean $expanded = false, boolean $idSubtable = false ) : DataTable | Piwik\DataTable\Map
$idSite integer
$period string
$date Piwik\Date
$segment boolean
$expanded boolean
$idSubtable boolean
리턴 Piwik\DataTable | Piwik\DataTable\Map

getPageUrl() 공개 메소드

public getPageUrl ( $pageUrl, $idSite, $period, $date, $segment = false )

getPageUrls() 공개 메소드

public 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
$idSite integer
$period string
$date Piwik\Date
$segment boolean
$expanded boolean
$idSubtable boolean | integer
$depth boolean | integer
$flat boolean | integer
리턴 Piwik\DataTable | Piwik\DataTable\Map

getPageUrlsFollowingSiteSearch() 공개 메소드

public getPageUrlsFollowingSiteSearch ( integer $idSite, string $period, Date $date, boolean $segment = false, boolean $expanded = false, boolean $idSubtable = false ) : DataTable | Piwik\DataTable\Map
$idSite integer
$period string
$date Piwik\Date
$segment boolean
$expanded boolean
$idSubtable boolean
리턴 Piwik\DataTable | Piwik\DataTable\Map

getSiteSearchCategories() 공개 메소드

public getSiteSearchCategories ( integer $idSite, string $period, Date $date, boolean $segment = false ) : DataTable | Piwik\DataTable\Map
$idSite integer
$period string
$date Piwik\Date
$segment boolean
리턴 Piwik\DataTable | Piwik\DataTable\Map

getSiteSearchKeywords() 공개 메소드

public getSiteSearchKeywords ( $idSite, $period, $date, $segment = false )

getSiteSearchKeywordsRaw() 보호된 메소드

protected getSiteSearchKeywordsRaw ( $idSite, $period, $date, $segment )

getSiteSearchNoResultKeywords() 공개 메소드

public getSiteSearchNoResultKeywords ( $idSite, $period, $date, $segment = false )

keepPagesFollowingSearch() 보호된 메소드

protected keepPagesFollowingSearch ( DataTable $dataTable )
$dataTable Piwik\DataTable