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

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

VisitorInterestModule
getVisitorInterest()

Initialise the VisitorInterest Module

VisitsSummaryModule
getVisitsSummary()

Initialise the VisitsSummary 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(string $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 41
__construct(ConfigRepository $config, RequestRepository $request)

Piwik constructor.

Parameters

ConfigRepository $config
RequestRepository $request

in ConfigTrait at line 28
string getSiteId()

Retrieve Site ID from configuration

Return Value

string

site id retrieved from configuration

in ConfigTrait at line 37
string getPiwikUrl()

Retrieve Piwik URL from configuration

Return Value

string

piwik url retrieved from configuration

at line 53
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 67
ActionsModule getActions()

Initialise the Actions module

Return Value

ActionsModule

See also

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

at line 78
APIModule getAPI()

Initialise the API Module

Return Value

APIModule

See also

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

at line 89
EventsModule getEvents()

Initialise the Events Module

Return Value

EventsModule

See also

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

at line 100
LiveModule getLive()

Initialise the Live Module

Return Value

LiveModule

See also

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

at line 111
ProviderModule getProvider()

Initialise the Provider Module

Return Value

ProviderModule

See also

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

at line 122
ReferrersModule getReferrers()

Initialise the Referrers Module

Return Value

ReferrersModule

See also

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

at line 133
SEOModule getSEO()

Initialise the SEO Module

Return Value

SEOModule

See also

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

at line 144
SitesManagerModule getSitesManager()

Initialise the SitesManager Module

Return Value

SitesManagerModule

See also

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

at line 155
VisitorInterestModule getVisitorInterest()

Initialise the VisitorInterest Module

Return Value

VisitorInterestModule

See also

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

at line 166
VisitsSummaryModule getVisitsSummary()

Initialise the VisitsSummary Module

Return Value

VisitsSummaryModule

See also

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

at line 176
string getTag()

Get javascript tag for use in tracking the website

Return Value

string

at line 203
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 215
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 227
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 239
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 252
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 264
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 289
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 301
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 313
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 325
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 337
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 350
mixed seo_rank(string $siteId, string $format = null) deprecated

deprecated

Get SEO Rank for the website

Parameters

string $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 361
string tag() deprecated

deprecated

Get javascript tag for use in tracking the website

Return Value

string

See also

Piwik::getTag

at line 374
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