1. class
  2. RobBrazier
  3. \
  4. Piwik
  5. \
  6. Piwik

Piwik

class Piwik (View source)

Class Piwik.

Traits

ConfigTrait

Properties

protected ConfigRepository $config from  ConfigTrait

Methods

__construct(ConfigRepository $config, RequestRepository $request)

Piwik constructor.

string
getSiteId()

Retrieve Site ID from configuration.

from  ConfigTrait
string
getPiwikUrl()

Retrieve Piwik URL from configuration.

from  ConfigTrait
string
convertUrl(string $url, bool $https)

Convert URL from HTTP to HTTPS and vice versa.

ActionsModule
getActions()

Initialise the Actions module.

APIModule
getAPI()

Initialise the API Module.

ContentsModule
getContents()

Initialise the Contents Module.

EventsModule
getEvents()

Initialise the Events Module.

LiveModule
getLive()

Initialise the Live Module.

ProviderModule
getProvider()

Initialise the Provider Module.

ReferrersModule
getReferrers()

Initialise the Referrers Module.

SEOModule
getSEO()

Initialise the SEO Module.

SitesManagerModule
getSitesManager()

Initialise the SitesManager Module.

UsersManagerModule
getUsersManager()

Initialise the UsersManager Module.

VisitorInterestModule
getVisitorInterest()

Initialise the VisitorInterest Module.

VisitsSummaryModule
getVisitsSummary()

Initialise the VisitsSummary Module.

UserCountryModule
getUserCountry()

Initialise the UserCountryModule Module.

DevicesDetectionModule
getDevicesDetection()

Initialise the DevicesDetection Module.

string
getTag()

Get javascript tag for use in tracking the website.

mixed
getCustom(RequestOptions $requestOptions)

Create a custom request N.B. It is safer to raise a GitHub issue to request another API method.

mixed
actions(string $format = null) deprecated

Get actions (hits) for the specific time period.

mixed
downloads(string $format = null) deprecated

Get file downloads for the specific time period.

mixed
keywords(string $format = null) deprecated

Get search keywords for the specific time period.

mixed
last_visits(int $count, string $format = null) deprecated

Get information about last 10 visits (ip, time, country, pages, etc.).

mixed
last_visits_parsed(int $count, string $format = null) deprecated

Get information about last 10 visits (ip, time, country, pages, etc.) in a formatted array with GeoIP information if enabled.

mixed
outlinks(string $format = null) deprecated

Get outlinks for the specific time period.

mixed
page_titles(string $format = null) deprecated

Get page visit information for the specific time period.

mixed
search_engines(string $format = null) deprecated

Get search engine referer information for the specific time period.

mixed
unique_visitors(string $format = null) deprecated

Get unique visitors for the specific time period.

mixed
visits(string $format = null) deprecated

Get all visits for the specific time period.

mixed
websites(string $format = null) deprecated

Get referring websites (traffic sources) for the specific time period.

mixed
seo_rank(int $siteId, string $format = null) deprecated

Get SEO Rank for the website.

string
tag() deprecated

Get javascript tag for use in tracking the website.

mixed
version(string $format = null) deprecated

Get Version of the Piwik Server.

Details

at line 45
__construct(ConfigRepository $config, RequestRepository $request)

Piwik constructor.

Parameters

ConfigRepository $config
RequestRepository $request

in ConfigTrait at line 30
string getSiteId()

Retrieve Site ID from configuration.

Return Value

string

site id retrieved from configuration

in ConfigTrait at line 40
string getPiwikUrl()

Retrieve Piwik URL from configuration.

Return Value

string

piwik url retrieved from configuration

at line 59
protected string convertUrl(string $url, bool $https)

Convert URL from HTTP to HTTPS and vice versa.

Parameters

string $url
bool $https

Return Value

string

at line 75
ActionsModule getActions()

Initialise the Actions module.

Return Value

ActionsModule

See also

https://developer.matomo.org/api-reference/reporting-api#Actions for arguments

at line 87
APIModule getAPI()

Initialise the API Module.

Return Value

APIModule

See also

https://developer.matomo.org/api-reference/reporting-api#API for arguments

at line 99
ContentsModule getContents()

Initialise the Contents Module.

Return Value

ContentsModule

See also

https://developer.matomo.org/api-reference/reporting-api#Contents for arguments

at line 111
EventsModule getEvents()

Initialise the Events Module.

Return Value

EventsModule

See also

https://developer.matomo.org/api-reference/reporting-api#Events for arguments

at line 123
LiveModule getLive()

Initialise the Live Module.

Return Value

LiveModule

See also

https://developer.matomo.org/api-reference/reporting-api#Live for arguments

at line 135
ProviderModule getProvider()

Initialise the Provider Module.

Return Value

ProviderModule

See also

https://developer.matomo.org/api-reference/reporting-api#Provider for arguments

at line 147
ReferrersModule getReferrers()

Initialise the Referrers Module.

Return Value

ReferrersModule

See also

https://developer.matomo.org/api-reference/reporting-api#Referrers for arguments

at line 159
SEOModule getSEO()

Initialise the SEO Module.

Return Value

SEOModule

See also

https://developer.matomo.org/api-reference/reporting-api#SEO for arguments

at line 171
SitesManagerModule getSitesManager()

Initialise the SitesManager Module.

Return Value

SitesManagerModule

See also

https://developer.matomo.org/api-reference/reporting-api#SitesManager for arguments

at line 183
UsersManagerModule getUsersManager()

Initialise the UsersManager Module.

Return Value

UsersManagerModule

See also

https://developer.matomo.org/api-reference/reporting-api#UsersManager for arguments

at line 195
VisitorInterestModule getVisitorInterest()

Initialise the VisitorInterest Module.

Return Value

VisitorInterestModule

See also

https://developer.matomo.org/api-reference/reporting-api#VisitorInterest for arguments

at line 207
VisitsSummaryModule getVisitsSummary()

Initialise the VisitsSummary Module.

Return Value

VisitsSummaryModule

See also

https://developer.matomo.org/api-reference/reporting-api#VisitsSummary for arguments

at line 219
UserCountryModule getUserCountry()

Initialise the UserCountryModule Module.

Return Value

UserCountryModule

See also

https://developer.matomo.org/api-reference/reporting-api#UserCountry for arguments

at line 231
DevicesDetectionModule getDevicesDetection()

Initialise the DevicesDetection Module.

Return Value

DevicesDetectionModule

See also

https://developer.matomo.org/api-reference/reporting-api#DevicesDetection for arguments

at line 241
string getTag()

Get javascript tag for use in tracking the website.

Return Value

string

at line 277
mixed getCustom(RequestOptions $requestOptions)

Create a custom request N.B. It is safer to raise a GitHub issue to request another API method.

Parameters

RequestOptions $requestOptions

Return Value

mixed

See also

https://github.com/RobBrazier/Laravel_Piwik/issues

at line 292
mixed actions(string $format = null) deprecated

deprecated

Get actions (hits) for the specific time period.

Parameters

string $format

Override string for the format of the API Query to be returned as

Return Value

mixed

See also

VisitsSummaryModule::getActions

at line 307
mixed downloads(string $format = null) deprecated

deprecated

Get file downloads for the specific time period.

Parameters

string $format

Override string for the format of the API Query to be returned as

Return Value

mixed

See also

ActionsModule::getDownloads

at line 322
mixed keywords(string $format = null) deprecated

deprecated

Get search keywords for the specific time period.

Parameters

string $format

Override string for the format of the API Query to be returned as

Return Value

mixed

See also

ReferrersModule::getKeywords

at line 338
mixed last_visits(int $count, string $format = null) deprecated

deprecated

Get information about last 10 visits (ip, time, country, pages, etc.).

Parameters

int $count

Limit the number of visits returned by $count
string $format

Override string for the format of the API Query to be returned as

Return Value

mixed

See also

LiveModule::getLastVisitsDetails

at line 354
mixed last_visits_parsed(int $count, string $format = null) deprecated

deprecated

Get information about last 10 visits (ip, time, country, pages, etc.) in a formatted array with GeoIP information if enabled.

Parameters

int $count

Limit the number of visits returned by $count
string $format

Override string for the format of the API Query to be returned as

Return Value

mixed

deprecated

Get outlinks for the specific time period.

Parameters

string $format

Override string for the format of the API Query to be returned as

Return Value

mixed

See also

ActionsModule::getOutlinks

at line 384
mixed page_titles(string $format = null) deprecated

deprecated

Get page visit information for the specific time period.

Parameters

string $format

Override string for the format of the API Query to be returned as

Return Value

mixed

See also

ActionsModule::getPageTitles

at line 399
mixed search_engines(string $format = null) deprecated

deprecated

Get search engine referer information for the specific time period.

Parameters

string $format

Override string for the format of the API Query to be returned as

Return Value

mixed

See also

ReferrersModule::getSearchEngines

at line 414
mixed unique_visitors(string $format = null) deprecated

deprecated

Get unique visitors for the specific time period.

Parameters

string $format

Override string for the format of the API Query to be returned as

Return Value

mixed

See also

VisitsSummaryModule::getUniqueVisitors

at line 429
mixed visits(string $format = null) deprecated

deprecated

Get all visits for the specific time period.

Parameters

string $format

Override string for the format of the API Query to be returned as

Return Value

mixed

See also

VisitsSummaryModule::getVisits

at line 444
mixed websites(string $format = null) deprecated

deprecated

Get referring websites (traffic sources) for the specific time period.

Parameters

string $format

Override string for the format of the API Query to be returned as

Return Value

mixed

See also

ReferrersModule::getWebsites

at line 460
mixed seo_rank(int $siteId, string $format = null) deprecated

deprecated

Get SEO Rank for the website.

Parameters

int $siteId

Override for ID, so you can specify one rather than fetching it from config
string $format

Override string for the format of the API Query to be returned as

Return Value

mixed

See also

SEOModule::getRankFromSiteId

at line 473
string tag() deprecated

deprecated

Get javascript tag for use in tracking the website.

Return Value

string

See also

Piwik::getTag

at line 488
mixed version(string $format = null) deprecated

deprecated

Get Version of the Piwik Server.

Parameters

string $format

Override string for the format of the API Query to be returned as

Return Value

mixed

See also

APIModule::getPiwikVersion