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

Piwik

class Piwik (View source)

Class Piwik

Methods

__construct(array $args = array())

No description

object
actions($format = null)

actions Get actions (hits) for the specific time period

array
downloads($format = null)

downloads Get file downloads for the specific time period

array
keywords($format = null)

keywords Get search keywords for the specific time period

array
last_visits($count, $format = null)

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

array
last_visits_parsed($count, $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

array
outlinks($format = null)

actions Get outlinks for the specific time period

array
page_titles($format = null)

page_titles Get page visit information for the specific time period

array
search_engines($format = null)

search_engines Get search engine referer information for the specific time period

array
unique_visitors($format = null)

unique_visitors Get unique visitors for the specific time period

array
visits($format = null)

visits Get all visits for the specific time period

array
websites($format = null)

websites Get refering websites (traffic sources) for the specific time period

string
tag()

tag Get javascript tag for use in tracking the website

array
seo_rank($id, $format = 'json')

seo_rank Get SEO Rank for the website

mixed
version($format = null)

version Get Version of the Piwik Server

mixed
custom($method, $arguments, $id = false, $period = false, $format = null)

No description

Details

at line 86
__construct(array $args = array())

No description

Parameters

array $args

at line 355
object actions($format = null)

actions Get actions (hits) for the specific time period

Parameters

$format

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

Return Value

object

at line 367
array downloads($format = null)

downloads Get file downloads for the specific time period

Parameters

$format

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

Return Value

array

at line 379
array keywords($format = null)

keywords Get search keywords for the specific time period

Parameters

$format

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

Return Value

array

at line 392
array last_visits($count, $format = null)

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

Parameters

$count

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

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

Return Value

array

at line 406
array last_visits_parsed($count, $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

$count

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

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

Return Value

array

actions Get outlinks for the specific time period

Parameters

$format

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

Return Value

array

at line 531
array page_titles($format = null)

page_titles Get page visit information for the specific time period

Parameters

$format

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

Return Value

array

at line 543
array search_engines($format = null)

search_engines Get search engine referer information for the specific time period

Parameters

$format

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

Return Value

array

at line 555
array unique_visitors($format = null)

unique_visitors Get unique visitors for the specific time period

Parameters

$format

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

Return Value

array

at line 567
array visits($format = null)

visits Get all visits for the specific time period

Parameters

$format

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

Return Value

array

at line 579
array websites($format = null)

websites Get refering websites (traffic sources) for the specific time period

Parameters

$format

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

Return Value

array

at line 593
string tag()

tag Get javascript tag for use in tracking the website

Note: Works best when using PHP as the format

Return Value

string

at line 621
array seo_rank($id, $format = 'json')

seo_rank Get SEO Rank for the website

Parameters

$id

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

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

Return Value

array

at line 636
mixed version($format = null)

version Get Version of the Piwik Server

Parameters

$format

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

Return Value

mixed

at line 648
mixed custom($method, $arguments, $id = false, $period = false, $format = null)

No description

Parameters

$method

string The API method, as found in the Piwik API documentation
$arguments

array|null A multidimensional map of key => value for custom data to be added onto the url, e.g. ["test" => "foo"] ===> &test=foo
$id

mixed values can be true/false to add the default site id, or you can specify the id here
$period

bool boolean value to determine whether the time period is appended to the API url
$format

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

Return Value

mixed