Description

The Live! API lets you access complete visit level information about your visitors. Combined with the power of Segmentation, you will be able to request visits filtered by any criteria.

The method "getLastVisitsDetails" will return extensive data for each visit, which includes: server time, visitId, visitorId, visitorType (new or returning), number of pages, list of all pages (and events, file downloaded and outlinks clicked), custom variables names and values set to this visit, number of goal conversions (and list of all Goal conversions for this visit, with time of conversion, revenue, URL, etc.), but also other attributes such as: days since last visit, days since first visit, country, continent, visitor IP, provider, referrer used (referrer name, keyword if it was a search engine, full URL), campaign name and keyword, operating system, browser, type of screen, resolution, supported browser plugins (flash, java, silverlight, pdf, etc.), various dates & times format to make it easier for API users... and more!

With the parameter '&segment=' you can filter the returned visits by any criteria (visitor IP, visitor ID, country, keyword used, time of day, etc.).

The method "getCounters" is used to return a simple counter: visits, number of actions, number of converted visits, in the last N minutes.

See also the documentation about Real time widget and visitor level reports in Matomo.

Type hierarchy

Class usage:

This class is used in:
Class Package
Piwik\Plugins\Live\Controller
piwik/piwik 13835.x-dev
Piwik\Plugins\Live\Controller
piwik/piwik 13383.x-dev
Piwik\Plugins\Live\Controller
piwik/piwik 13325.x-dev
Piwik\Plugins\Live\Controller
piwik/piwik 13272.x-dev
Piwik\Plugins\Live\Controller
piwik/piwik 11942.x-dev
Piwik\Plugins\Live\tests\System\ApiCounterTest
piwik/piwik 10801.x-dev
Piwik\Plugins\Live\Controller
piwik/piwik 10801.x-dev
Piwik\Plugins\Live\tests\System\APITest
piwik/piwik 7105.x-dev
Piwik\Plugins\Live\Controller
piwik/piwik 11058.x-dev