Skip to content
Extraits de code Groupes Projets
Valider 7f1dbcbf rédigé par mattab's avatar mattab
Parcourir les fichiers

New HTTP APIs: API.getGlossaryMetrics & getGlossaryReports (w/ system tests)

parent 3d7a6188
Aucune branche associée trouvée
Aucune étiquette associée trouvée
Aucune requête de fusion associée trouvée
Masquer les modifications d'espaces
En ligne Côte à côte
plugins/API/API.php
+ 26
− 0
Voir le fichier @ 7f1dbcbf
...@@ -555,6 +555,32 @@ class API extends \Piwik\Plugin\API ...@@ -555,6 +555,32 @@ class API extends \Piwik\Plugin\API
return $values; return $values;
} }
/**
* A glossary of all reports and their definition
*
* @param $idSite
* @return array
*/
public function getGlossaryReports($idSite)
{
$glossary = StaticContainer::get('Piwik\Plugins\API\Glossary');
$glossary->setIdSite($idSite);
return $glossary->reportsGlossary();
}
/**
* A glossary of all metrics and their definition
*
* @param $idSite
* @return array
*/
public function getGlossaryMetrics($idSite)
{
$glossary = StaticContainer::get('Piwik\Plugins\API\Glossary');
$glossary->setIdSite($idSite);
return $glossary->metricsGlossary();
}
/** /**
* @param $segmentName * @param $segmentName
* @return bool * @return bool
......
plugins/API/Controller.php
+ 2
− 4
Voir le fichier @ 7f1dbcbf
...@@ -143,11 +143,9 @@ class Controller extends \Piwik\Plugin\Controller ...@@ -143,11 +143,9 @@ class Controller extends \Piwik\Plugin\Controller
{ {
Piwik::checkUserHasSomeViewAccess(); Piwik::checkUserHasSomeViewAccess();
$glossary = StaticContainer::get('Piwik\Plugins\API\Glossary');
$glossary->setIdSite($this->idSite);
return $this->renderTemplate('glossary', array( return $this->renderTemplate('glossary', array(
'reports' => $glossary->reportsGlossary(), 'reports' => Request::processRequest('API', array('method' => 'API.getGlossaryReports')),
'metrics' => $glossary->metricsGlossary(), 'metrics' => Request::processRequest('API', array('method' => 'API.getGlossaryMetrics')),
)); ));
} }
} }
plugins/API/Glossary.php
+ 1
− 2
Voir le fichier @ 7f1dbcbf
...@@ -12,10 +12,9 @@ namespace Piwik\Plugins\API; ...@@ -12,10 +12,9 @@ namespace Piwik\Plugins\API;
class Glossary class Glossary
{ {
protected $metadata = array(); protected $metadata = array();
public function setIdSite($idSite) public function setIdSite($idSite)
{ {
$this->idSite = $idSite;
$this->metadata = API::getInstance()->getReportMetadata($idSite); $this->metadata = API::getInstance()->getReportMetadata($idSite);
} }
......
tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getGlossaryMetrics.xml 0 → 100644
+ 183
− 0
Voir le fichier @ 7f1dbcbf
<?xml version="1.0" encoding="utf-8" ?>
<result>
<row>
<name>% Search Exits (Site Search)</name>
<id>exit_rate</id>
<documentation>The percentage of visits that left the website after searching for this Keyword on your Site Search engine.</documentation>
</row>
<row>
<name>Actions</name>
<id>nb_actions</id>
<documentation>The number of actions performed by your visitors. Actions can be page views, internal site searches, downloads or outlinks.</documentation>
</row>
<row>
<name>Actions per Visit</name>
<id>nb_actions_per_visit</id>
<documentation>The average number of actions (page views, site searches, downloads or outlinks) that were performed during the visits.</documentation>
</row>
<row>
<name>Avg. Time on Website</name>
<id>avg_time_on_site</id>
<documentation>The average duration of a visit.</documentation>
</row>
<row>
<name>Avg. generation time</name>
<id>avg_time_generation</id>
<documentation>The average time it took to generate the page. This metric includes the time it took the server to generate the web page, plus the time it took for the visitor to download the response from the server. A lower 'Avg. generation time' means a faster website for your visitors!</documentation>
</row>
<row>
<name>Avg. time on page</name>
<id>avg_time_on_page</id>
<documentation>The average amount of time visitors spent on this page (only the page, not the entire website).</documentation>
</row>
<row>
<name>Bounce Rate</name>
<id>bounce_rate</id>
<documentation>The percentage of visits that only had a single pageview. This means, that the visitor left the website directly from the entrance page.</documentation>
</row>
<row>
<name>Bounce Rate (Actions)</name>
<id>bounce_rate</id>
<documentation>The percentage of visits that started on this page and left the website straight away.</documentation>
</row>
<row>
<name>Bounces</name>
<id>entry_bounce_count</id>
<documentation>Number of visits that started and ended on this page. This means that the visitor left the website after viewing only this page.</documentation>
</row>
<row>
<name>Clicked in search results</name>
<id>nb_hits_following_search</id>
<documentation>The number of times this Page was visited after a visitor did a search on your website, and clicked on this page in the search results.</documentation>
</row>
<row>
<name>Conversion Rate</name>
<id>conversion_rate</id>
<documentation>The percentage of visits that triggered a goal conversion.</documentation>
</row>
<row>
<name>Downloads</name>
<id>nb_downloads</id>
<documentation>The number of times this link was clicked.</documentation>
</row>
<row>
<name>Entrances</name>
<id>entry_nb_visits</id>
<documentation>Number of visits that started on this page.</documentation>
</row>
<row>
<name>Events with a value</name>
<id>nb_events_with_value</id>
<documentation>Number of events where an Event value was set</documentation>
</row>
<row>
<name>Exit rate</name>
<id>exit_rate</id>
<documentation>The percentage of visits that left the website after viewing this page.</documentation>
</row>
<row>
<name>Exits</name>
<id>exit_nb_visits</id>
<documentation>Number of visits that ended on this page.</documentation>
</row>
<row>
<name>Maximum value</name>
<id>max_event_value</id>
<documentation>The maximum value for this event</documentation>
</row>
<row>
<name>Minimum value</name>
<id>min_event_value</id>
<documentation>The minimum value for this event</documentation>
</row>
<row>
<name>Outlinks</name>
<id>nb_outlinks</id>
<documentation>The number of times this link was clicked.</documentation>
</row>
<row>
<name>Pageviews</name>
<id>nb_pageviews</id>
<documentation>The number of times this page was visited.</documentation>
</row>
<row>
<name>Search Results pages</name>
<id>nb_pages_per_search</id>
<documentation>Visitors will search on your website, and sometimes click &quot;next&quot; to view more results. This is the average number of search results pages viewed for this keyword.</documentation>
</row>
<row>
<name>Searches</name>
<id>nb_searches</id>
<documentation>The number of visits that searched for this keyword on your website's search engine.</documentation>
</row>
<row>
<name>Searches (Site Search)</name>
<id>nb_visits</id>
<documentation>The number of visits that searched for this keyword on your website's search engine.</documentation>
</row>
<row>
<name>The average of all values for this event</name>
<id>avg_event_value</id>
<documentation>The average of all values for this event</documentation>
</row>
<row>
<name>Total Pageviews</name>
<id>nb_hits</id>
<documentation>The number of times this page was visited.</documentation>
</row>
<row>
<name>Total events</name>
<id>nb_events</id>
<documentation>Total number of events</documentation>
</row>
<row>
<name>Total value</name>
<id>sum_event_value</id>
<documentation>The sum of event values</documentation>
</row>
<row>
<name>Unique Clicks (Actions)</name>
<id>nb_visits</id>
<documentation>The number of visits that involved a click on this link. If a link was clicked multiple times during one visit, it is only counted once.</documentation>
</row>
<row>
<name>Unique Downloads</name>
<id>nb_uniq_downloads</id>
<documentation>The number of visits that involved a click on this link. If a link was clicked multiple times during one visit, it is only counted once.</documentation>
</row>
<row>
<name>Unique Downloads (Actions)</name>
<id>nb_visits</id>
<documentation>The number of visits that involved a click on this link. If a link was clicked multiple times during one visit, it is only counted once.</documentation>
</row>
<row>
<name>Unique Outlinks</name>
<id>nb_uniq_outlinks</id>
<documentation>The number of visits that involved a click on this link. If a link was clicked multiple times during one visit, it is only counted once.</documentation>
</row>
<row>
<name>Unique Pageviews</name>
<id>nb_uniq_pageviews</id>
<documentation>The number of visits that included this page. If a page was viewed multiple times during one visit, it is only counted once.</documentation>
</row>
<row>
<name>Unique Pageviews (Actions)</name>
<id>nb_visits</id>
<documentation>The number of visits that included this page. If a page was viewed multiple times during one visit, it is only counted once.</documentation>
</row>
<row>
<name>Unique visitors</name>
<id>nb_uniq_visitors</id>
<documentation>The number of unduplicated visitors coming to your website. Every user is only counted once, even if he visits the website multiple times a day.</documentation>
</row>
<row>
<name>Users</name>
<id>nb_users</id>
<documentation>The number of users logged in your website. It is the number of unique active users that have a User ID set (via the Tracking code function 'setUserId').</documentation>
</row>
<row>
<name>Visits</name>
<id>nb_visits</id>
<documentation>If a visitor comes to your website for the first time or if he visits a page more than 30 minutes after his last page view, this will be recorded as a new visit.</documentation>
</row>
</result>
\ No newline at end of file
tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getGlossaryReports.xml 0 → 100644
+ 151
− 0
Voir le fichier @ 7f1dbcbf
<?xml version="1.0" encoding="utf-8" ?>
<result>
<row>
<name>All Referrers (Referrers)</name>
<documentation>This report shows all your Referrers in one unified report, listing all Websites, Search keywords and Campaigns used by your visitors to find your website.</documentation>
</row>
<row>
<name>Browser Plugins (Visitor Settings)</name>
<documentation>This report shows which browser plugins your visitors had enabled. This information might be important for choosing the right way to deliver your content.</documentation>
</row>
<row>
<name>Browser engines (Visitor Devices)</name>
<documentation>This report shows your visitors' browsers broken down into browser engines. &lt;br /&gt; The most important information for web developers is what kind of rendering engine their visitors are using. The labels contain the names of the engines followed by the most common browser using that engine in brackets.</documentation>
</row>
<row>
<name>Campaigns (Referrers)</name>
<documentation>This report shows which campaigns led visitors to your website. &lt;br /&gt; For more information about tracking campaigns, read the &lt;a href=&quot;http://piwik.org/docs/tracking-campaigns/&quot; rel=&quot;noreferrer&quot; target=&quot;_blank&quot;&gt;campaigns documentation on piwik.org&lt;/a&gt;</documentation>
</row>
<row>
<name>City (Visitors)</name>
<documentation>This report shows the cities your visitors were in when they accessed your website.&lt;br/&gt;In order to see data for this report, you must setup GeoIP in the Geolocation admin tab. The commercial &lt;a rel=&quot;noreferrer&quot; target=&quot;_blank&quot; href=&quot;http://www.maxmind.com/?rId=piwik&quot;&gt;Maxmind&lt;/a&gt; GeoIP databases are more accurate than the free ones. To see how accurate they are, click &lt;a rel=&quot;noreferrer&quot; target=&quot;_blank&quot; href=&quot;http://www.maxmind.com/en/city_accuracy?rId=piwik&quot;&gt;here&lt;/a&gt;.</documentation>
</row>
<row>
<name>Continent (Visitors)</name>
<documentation>This report shows which continent your visitors were in when they accessed your website.</documentation>
</row>
<row>
<name>Country (Visitors)</name>
<documentation>This report shows which country your visitors were in when they accessed your website.</documentation>
</row>
<row>
<name>Custom Variables (Visitors)</name>
<documentation>This report contains information about your Custom Variables. Click on a variable name to see the distribution of the values. &lt;br /&gt; For more information about Custom Variables in general, read the &lt;a href=&quot;http://piwik.org/docs/custom-variables/&quot; rel=&quot;noreferrer&quot; target=&quot;_blank&quot;&gt;Custom Variables documentation on piwik.org&lt;/a&gt;</documentation>
</row>
<row>
<name>Downloads (Actions)</name>
<documentation>In this report, you can see which files your visitors have downloaded. &lt;br /&gt; What Piwik counts as a download is the click on a download link. Whether the download was completed or not isn't known to Piwik.</documentation>
</row>
<row>
<name>Entry page titles (Actions)</name>
<documentation>This report contains information about the titles of entry pages that were used during the specified period. Use the plus and minus icons on the left to navigate.</documentation>
</row>
<row>
<name>Entry pages (Actions)</name>
<documentation>This report contains information about the entry pages that were used during the specified period. An entry page is the first page that a user views during his visit. &lt;br /&gt; The entry URLs are displayed as a folder structure.&lt;br /&gt;Use the plus and minus icons on the left to navigate.</documentation>
</row>
<row>
<name>Exit page titles (Actions)</name>
<documentation>This report contains information about the titles of exit pages that occurred during the specified period. Use the plus and minus icons on the left to navigate.</documentation>
</row>
<row>
<name>Exit pages (Actions)</name>
<documentation>This report contains information about the exit pages that occurred during the specified period. An exit page is the last page that a user views during his visit. &lt;br /&gt; The exit URLs are displayed as a folder structure.&lt;br /&gt;Use the plus and minus icons on the left to navigate.</documentation>
</row>
<row>
<name>Keywords (Referrers)</name>
<documentation>This report shows which keywords users were searching for before they were referred to your website. &lt;br /&gt; By clicking on a row in the table, you can see the distribution of search engines that were queried for the keyword.</documentation>
</row>
<row>
<name>Length of Visits (Visitors)</name>
<documentation>In this report, you can see how many visits had a certain total duration. Initially, the report is shown as a tag cloud, more common durations are displayed in a larger font.&lt;br /&gt;Please note, that you can view the report in other ways than as a tag cloud. Use the controls at the bottom of the report to do so.</documentation>
</row>
<row>
<name>Outlinks (Actions)</name>
<documentation>This report shows a hierarchical list of outlink URLs that were clicked by your visitors. An outlink is a link that leads the visitor away from your website (to another domain).&lt;br /&gt;Use the plus and minus icons on the left to navigate.</documentation>
</row>
<row>
<name>Page Titles Following a Site Search (Site Search)</name>
<documentation>When visitors search on your website, they are looking for a particular page, content, product, or service. This report lists the pages that were clicked the most after an internal search. In other words, the list of pages the most searched for by visitors already on your website.&lt;br/&gt;Use the plus and minus icons on the left to navigate.</documentation>
</row>
<row>
<name>Page URLs (Actions)</name>
<documentation>This report contains information about the page URLs that have been visited. &lt;br /&gt; The table is organized hierarchically, the URLs are displayed as a folder structure.&lt;br /&gt;Use the plus and minus icons on the left to navigate.</documentation>
</row>
<row>
<name>Page titles (Actions)</name>
<documentation>This report contains information about the titles of the pages that have been visited. &lt;br /&gt; The page title is the HTML &lt;title&gt; Tag that most browsers show in their window title.</documentation>
</row>
<row>
<name>Pages Following a Site Search (Site Search)</name>
<documentation>When visitors search on your website, they are looking for a particular page, content, product, or service. This report lists the pages that were clicked the most after an internal search. In other words, the list of pages the most searched for by visitors already on your website.&lt;br/&gt;Use the plus and minus icons on the left to navigate.</documentation>
</row>
<row>
<name>Pages per Visit (Visitors)</name>
<documentation>In this report, you can see how many visits involved a certain number of pageviews. Initially, the report is shown as a tag cloud, more common numbers of pages are displayed in a larger font.&lt;br /&gt;Please note, that you can view the report in other ways than as a tag cloud. Use the controls at the bottom of the report to do so.</documentation>
</row>
<row>
<name>Provider (Visitors)</name>
<documentation>This report shows which Internet Service Providers your visitors used to access the website. You can click on a provider name for more details. &lt;br /&gt; If Piwik can't determine a visitor's provider, it is listed as IP.</documentation>
</row>
<row>
<name>Referrer Type (Referrers)</name>
<documentation>This table contains information about the distribution of the referrer types.&lt;br /&gt;&lt;b&gt;Direct Entry:&lt;/b&gt; A visitor has entered the URL in his browser and started browsing on your website - he entered the website directly.&lt;br /&gt;&lt;b&gt;Search Engines:&lt;/b&gt; A visitor was referred to your website by a search engine. &lt;br /&gt; See the &quot;Search Engines &amp; Keywords&quot; report for more details.&lt;br /&gt;&lt;b&gt;Websites:&lt;/b&gt; The visitor followed a link on another website that led to your site. &lt;br /&gt; See the &quot;Websites &amp; Social&quot; report for more details.&lt;br /&gt;&lt;b&gt;Campaigns:&lt;/b&gt; Visitors that came to your website as the result of a campaign. &lt;br /&gt; See the &quot;Campaigns&quot; report for more details.</documentation>
</row>
<row>
<name>Region (Visitors)</name>
<documentation>This report shows which region your visitors were in when they accessed your website.&lt;br/&gt;In order to see data for this report, you must setup GeoIP in the Geolocation admin tab. The commercial &lt;a rel=&quot;noreferrer&quot; target=&quot;_blank&quot; href=&quot;http://www.maxmind.com/?rId=piwik&quot;&gt;Maxmind&lt;/a&gt; GeoIP databases are more accurate than the free ones. To see how accurate they are, click &lt;a rel=&quot;noreferrer&quot; target=&quot;_blank&quot; href=&quot;http://www.maxmind.com/en/city_accuracy?rId=piwik&quot;&gt;here&lt;/a&gt;.</documentation>
</row>
<row>
<name>Search Categories (Site Search)</name>
<documentation>This report lists the Categories that visitors selected when they made a Search on your website.&lt;br/&gt;For example, Ecommerce websites typically have a &quot;Category&quot; selector so that visitors can restrict their searches to all products in a specific Category.</documentation>
</row>
<row>
<name>Search Engines (Referrers)</name>
<documentation>This report shows which search engines referred users to your website. &lt;br /&gt; By clicking on a row in the table, you can see what users were searching for using a specific search engine.</documentation>
</row>
<row>
<name>Search Keywords with No Results (Site Search)</name>
<documentation>Tracking searches that visitors make on your website is a very effective way to learn more about what your audience is looking for, it can help find ideas for new content, new Ecommerce products that potential customers might be searching for, and generally improve the visitors' experience on your website.&lt;br /&gt;&lt;br /&gt;This report lists the Search Keywords that did not return any Search result: maybe the search engine algorithm can be improved, or maybe your visitors are looking for content that is not (yet) on your website?</documentation>
</row>
<row>
<name>Site Search Keywords (Site Search)</name>
<documentation>This report lists the Search Keywords that visitors searched for on your internal Search Engine.&lt;br/&gt;&lt;br/&gt;Tracking searches that visitors make on your website is a very effective way to learn more about what your audience is looking for, it can help find ideas for new content, new Ecommerce products that potential customers might be searching for, and generally improve the visitors' experience on your website.&lt;br/&gt;&lt;br/&gt;&lt;a href=&quot;http://piwik.org/docs/site-search/&quot; rel=&quot;noreferrer&quot; target=&quot;_blank&quot;&gt;Learn more about Tracking how your visitors use your Search engine.&lt;/a&gt;</documentation>
</row>
<row>
<name>Social Networks (Referrers)</name>
<documentation>In this table, you can see which websites referred visitors to your site. &lt;br /&gt; By clicking on a row in the table, you can see which URLs the links to your website were on.</documentation>
</row>
<row>
<name>Visitor Browser (Visitor Devices)</name>
<documentation>This report contains information about what kind of browser your visitors were using. Each browser version is listed separately.</documentation>
</row>
<row>
<name>Visitor Configuration (Visitor Settings)</name>
<documentation>This report shows the most common overall configurations that your visitors had. A configuration is the combination of an operating system, a browser type and a screen resolution.</documentation>
</row>
<row>
<name>Visits by Day of Week (Visits Summary)</name>
<documentation>This graph shows the number of visits your website received on each day of the week.</documentation>
</row>
<row>
<name>Visits by Local Time (Visits Summary)</name>
<documentation>This graph shows what time it was in the &lt;strong&gt; visitors' time zones &lt;/strong&gt; during their visits.</documentation>
</row>
<row>
<name>Visits by Server Time (Visits Summary)</name>
<documentation>This graph shows what time it was in the &lt;strong&gt; server's time zone &lt;/strong&gt; during the visits.</documentation>
</row>
<row>
<name>Visits by Visit Number (Visitors)</name>
<documentation>In this report, you can see the number of visits who were the Nth visit, ie. visitors who visited your website at least N times.&lt;br /&gt;Please note, that you can view the report in other ways than as a tag cloud. Use the controls at the bottom of the report to do so.</documentation>
</row>
<row>
<name>Visits by days since last visit (Visitors)</name>
<documentation>In this report, you can see how many visits were from visitors whose last visit was a certain number of days ago.</documentation>
</row>
<row>
<name>Websites (Referrers)</name>
<documentation>In this table, you can see which websites referred visitors to your site. &lt;br /&gt; By clicking on a row in the table, you can see which URLs the links to your website were on.</documentation>
</row>
</result>
\ No newline at end of file
0% ou .
You are about to add 0 people to the discussion. Proceed with caution.
Terminez d'abord l'édition de ce message.
Veuillez vous inscrire ou vous pour commenter