class LiveModule extends Module (View source)

Class LiveModule

Traits

Properties

protected RequestRepository $request from  Module

Methods

__construct(RequestRepository $request)

LiveModule constructor.

getOptions(string $format)

No description

from  Module
string
validateFormat(string $format)

Check format against allowed values

mixed
getCounters(int $lastMinutes, $arguments = [], string $format = null)

No description

mixed
getLastVisitsDetails(int $count, $arguments = [], string $format = null)

No description

array
getLastVisitsDetailsParsed(int $count, string $format = null)

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

mixed
getVisitorProfile(string $visitorId, $arguments = [], string $format = null)

No description

mixed
getMostRecentVisitorId($arguments = [], string $format = null)

No description

Details

__construct(RequestRepository $request)

LiveModule constructor.

Parameters

RequestRepository $request

protected RequestOptions getOptions(string $format)

No description

Parameters

string $format

response format

Return Value

RequestOptions

string validateFormat(string $format)

Check format against allowed values

Parameters

string $format

format to validate

Return Value

string

the format if it has passed validation

Exceptions

PiwikException

mixed getCounters(int $lastMinutes, $arguments = [], string $format = null)

No description

Parameters

int $lastMinutes

number of minutes to filter counters by (e.g. get counters for the last 30 minutes)

$arguments
string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed getLastVisitsDetails(int $count, $arguments = [], string $format = null)

No description

Parameters

int $count

number of last visits to get (if set to 0, retrieves all results)

$arguments
string $format

override format (defaults to one specified in config file)

Return Value

mixed

array getLastVisitsDetailsParsed(int $count, string $format = null)

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

Parameters

int $count

number of last visits to get (if set to 0, retrieves all results)

string $format

override format (defaults to one specified in config file)

Return Value

array

mixed getVisitorProfile(string $visitorId, $arguments = [], string $format = null)

No description

Parameters

string $visitorId

visitor id to search for

$arguments
string $format

override format (defaults to one specified in config file)

Return Value

mixed

mixed getMostRecentVisitorId($arguments = [], string $format = null)

No description

Parameters

$arguments
string $format

override format (defaults to one specified in config file)

Return Value

mixed