diff options
| author | Stefan Giehl <stefan@matomo.org> | 2021-01-05 03:41:51 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-05 03:41:51 +0300 |
| commit | da9c6159702a228c1d50b65b87dd416730c092b0 (patch) | |
| tree | 668f98c9bdba618df86556fa0afc014a8591e244 /tests | |
| parent | 6f60a5ebfa306e66055cf76d0f98d1b5f2f127be (diff) | |
Adds missing report documentations (#16878)
* Fix report documentation not shown when switching between related reports
* Adds report documentation for DevicesDetection reports
* Adds some more report documentations
* Adds documentation to Event reports
* Adds documentation to Content reports
* Adds documentation to VisitorFrequency report
* Adds documentation to Goals reports
* Adds documentation to VisitsSummary report
* fixes & test updates
* fix typo
Co-authored-by: Lukas Winkler <git@lw1.at>
* small tweaks to some docs
* revising some of the report documentation
* fix translation file
* updates expected test files
Co-authored-by: Lukas Winkler <git@lw1.at>
Co-authored-by: diosmosis <diosmosis@users.noreply.github.com>
Diffstat (limited to 'tests')
18 files changed, 239 insertions, 2 deletions
diff --git a/tests/PHPUnit/System/expected/test_CustomEvents_Events.getAction_flat__API.getProcessedReport_day.xml b/tests/PHPUnit/System/expected/test_CustomEvents_Events.getAction_flat__API.getProcessedReport_day.xml index c19a197eb4..2e47868d6e 100644 --- a/tests/PHPUnit/System/expected/test_CustomEvents_Events.getAction_flat__API.getProcessedReport_day.xml +++ b/tests/PHPUnit/System/expected/test_CustomEvents_Events.getAction_flat__API.getProcessedReport_day.xml @@ -9,6 +9,7 @@ <module>Events</module> <action>getAction</action> <dimension>Event Action</dimension> + <documentation>This report shows you the number of times each event action occurred. You can view the event categories and names that were tracked along with each event action in the row's subtable. You can change which is shown by changing the secondary dimension with the link at the bottom of the report.</documentation> <onlineGuideUrl>https://matomo.org/docs/event-tracking/</onlineGuideUrl> <dimensions> <Events_EventAction>Event Action</Events_EventAction> diff --git a/tests/PHPUnit/System/expected/test_CustomEvents_Events.getAction_lastN__API.getProcessedReport_day.xml b/tests/PHPUnit/System/expected/test_CustomEvents_Events.getAction_lastN__API.getProcessedReport_day.xml index e3970b7085..a1161a7921 100644 --- a/tests/PHPUnit/System/expected/test_CustomEvents_Events.getAction_lastN__API.getProcessedReport_day.xml +++ b/tests/PHPUnit/System/expected/test_CustomEvents_Events.getAction_lastN__API.getProcessedReport_day.xml @@ -9,6 +9,7 @@ <module>Events</module> <action>getAction</action> <dimension>Event Action</dimension> + <documentation>This report shows you the number of times each event action occurred. You can view the event categories and names that were tracked along with each event action in the row's subtable. You can change which is shown by changing the secondary dimension with the link at the bottom of the report.</documentation> <onlineGuideUrl>https://matomo.org/docs/event-tracking/</onlineGuideUrl> <dimensions> <Events_EventAction>Event Action</Events_EventAction> diff --git a/tests/PHPUnit/System/expected/test_CustomEvents_Events.getCategory_flat__API.getProcessedReport_day.xml b/tests/PHPUnit/System/expected/test_CustomEvents_Events.getCategory_flat__API.getProcessedReport_day.xml index 8daa941cd1..73d49cd636 100644 --- a/tests/PHPUnit/System/expected/test_CustomEvents_Events.getCategory_flat__API.getProcessedReport_day.xml +++ b/tests/PHPUnit/System/expected/test_CustomEvents_Events.getCategory_flat__API.getProcessedReport_day.xml @@ -9,6 +9,7 @@ <module>Events</module> <action>getCategory</action> <dimension>Event Category</dimension> + <documentation>This report shows the categories of each tracked event and how many times they occurred. You can view the event actions and names that were tracked along with each event category in each row's subtable. You can change which is shown by changing the secondary dimension with the link at the bottom of the report.</documentation> <onlineGuideUrl>https://matomo.org/docs/event-tracking/</onlineGuideUrl> <dimensions> <Events_EventCategory>Event Category</Events_EventCategory> diff --git a/tests/PHPUnit/System/expected/test_CustomEvents_Events.getCategory_lastN__API.getProcessedReport_day.xml b/tests/PHPUnit/System/expected/test_CustomEvents_Events.getCategory_lastN__API.getProcessedReport_day.xml index aa720728fd..950776e01d 100644 --- a/tests/PHPUnit/System/expected/test_CustomEvents_Events.getCategory_lastN__API.getProcessedReport_day.xml +++ b/tests/PHPUnit/System/expected/test_CustomEvents_Events.getCategory_lastN__API.getProcessedReport_day.xml @@ -9,6 +9,7 @@ <module>Events</module> <action>getCategory</action> <dimension>Event Category</dimension> + <documentation>This report shows the categories of each tracked event and how many times they occurred. You can view the event actions and names that were tracked along with each event category in each row's subtable. You can change which is shown by changing the secondary dimension with the link at the bottom of the report.</documentation> <onlineGuideUrl>https://matomo.org/docs/event-tracking/</onlineGuideUrl> <dimensions> <Events_EventCategory>Event Category</Events_EventCategory> diff --git a/tests/PHPUnit/System/expected/test_CustomEvents_Events.getName_flat__API.getProcessedReport_day.xml b/tests/PHPUnit/System/expected/test_CustomEvents_Events.getName_flat__API.getProcessedReport_day.xml index f32cfb8594..23a59720ae 100644 --- a/tests/PHPUnit/System/expected/test_CustomEvents_Events.getName_flat__API.getProcessedReport_day.xml +++ b/tests/PHPUnit/System/expected/test_CustomEvents_Events.getName_flat__API.getProcessedReport_day.xml @@ -9,6 +9,7 @@ <module>Events</module> <action>getName</action> <dimension>Event Name</dimension> + <documentation>This report shows you the names associated with each tracked event and how many times they occurred. You can view the event actions and categories that were tracked along with each event name in each row's subtable. You can change which is shown by changing the secondary dimension with the link at the bottom of the report.</documentation> <onlineGuideUrl>https://matomo.org/docs/event-tracking/</onlineGuideUrl> <dimensions> <Events_EventName>Event Name</Events_EventName> diff --git a/tests/PHPUnit/System/expected/test_CustomEvents_Events.getName_lastN__API.getProcessedReport_day.xml b/tests/PHPUnit/System/expected/test_CustomEvents_Events.getName_lastN__API.getProcessedReport_day.xml index e134d7ef78..9aadafb4fa 100644 --- a/tests/PHPUnit/System/expected/test_CustomEvents_Events.getName_lastN__API.getProcessedReport_day.xml +++ b/tests/PHPUnit/System/expected/test_CustomEvents_Events.getName_lastN__API.getProcessedReport_day.xml @@ -9,6 +9,7 @@ <module>Events</module> <action>getName</action> <dimension>Event Name</dimension> + <documentation>This report shows you the names associated with each tracked event and how many times they occurred. You can view the event actions and categories that were tracked along with each event name in each row's subtable. You can change which is shown by changing the secondary dimension with the link at the bottom of the report.</documentation> <onlineGuideUrl>https://matomo.org/docs/event-tracking/</onlineGuideUrl> <dimensions> <Events_EventName>Event Name</Events_EventName> diff --git a/tests/PHPUnit/System/expected/test_DataComparisonTest_processedReport__API.getProcessedReport_day.xml b/tests/PHPUnit/System/expected/test_DataComparisonTest_processedReport__API.getProcessedReport_day.xml index f5ea70ec54..669768bc41 100644 --- a/tests/PHPUnit/System/expected/test_DataComparisonTest_processedReport__API.getProcessedReport_day.xml +++ b/tests/PHPUnit/System/expected/test_DataComparisonTest_processedReport__API.getProcessedReport_day.xml @@ -8,6 +8,7 @@ <name>Visits Summary</name> <module>VisitsSummary</module> <action>get</action> + <documentation>This report provides a very general overview of how your visitors behave.</documentation> <metrics> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> <nb_visits>Visits</nb_visits> diff --git a/tests/PHPUnit/System/expected/test_OneVisitorTwoVisits_showColumns_onlyOne__API.getProcessedReport_day.xml b/tests/PHPUnit/System/expected/test_OneVisitorTwoVisits_showColumns_onlyOne__API.getProcessedReport_day.xml index dba7ff2e2a..11ad8114f3 100644 --- a/tests/PHPUnit/System/expected/test_OneVisitorTwoVisits_showColumns_onlyOne__API.getProcessedReport_day.xml +++ b/tests/PHPUnit/System/expected/test_OneVisitorTwoVisits_showColumns_onlyOne__API.getProcessedReport_day.xml @@ -8,6 +8,7 @@ <name>Visits Summary</name> <module>VisitsSummary</module> <action>get</action> + <documentation>This report provides a very general overview of how your visitors behave.</documentation> <metrics> <nb_visits>Visits</nb_visits> </metrics> diff --git a/tests/PHPUnit/System/expected/test_SiteSearch_Actions.get_firstSite_lastN__API.getProcessedReport_day.xml b/tests/PHPUnit/System/expected/test_SiteSearch_Actions.get_firstSite_lastN__API.getProcessedReport_day.xml index a5a008b823..6f84562905 100644 --- a/tests/PHPUnit/System/expected/test_SiteSearch_Actions.get_firstSite_lastN__API.getProcessedReport_day.xml +++ b/tests/PHPUnit/System/expected/test_SiteSearch_Actions.get_firstSite_lastN__API.getProcessedReport_day.xml @@ -7,6 +7,7 @@ <name>Actions - Main metrics</name> <module>Actions</module> <action>get</action> + <documentation>This report provides a very basic overview of what actions your visitors take on your website.</documentation> <metrics> <nb_pageviews>Pageviews</nb_pageviews> <nb_uniq_pageviews>Unique Pageviews</nb_uniq_pageviews> diff --git a/tests/PHPUnit/System/expected/test_SiteSearch_Actions.get_firstSite_lastN__API.getProcessedReport_month.xml b/tests/PHPUnit/System/expected/test_SiteSearch_Actions.get_firstSite_lastN__API.getProcessedReport_month.xml index 4dbb7749c0..3618178ddb 100644 --- a/tests/PHPUnit/System/expected/test_SiteSearch_Actions.get_firstSite_lastN__API.getProcessedReport_month.xml +++ b/tests/PHPUnit/System/expected/test_SiteSearch_Actions.get_firstSite_lastN__API.getProcessedReport_month.xml @@ -7,6 +7,7 @@ <name>Actions - Main metrics</name> <module>Actions</module> <action>get</action> + <documentation>This report provides a very basic overview of what actions your visitors take on your website.</documentation> <metrics> <nb_pageviews>Pageviews</nb_pageviews> <nb_uniq_pageviews>Unique Pageviews</nb_uniq_pageviews> diff --git a/tests/PHPUnit/System/expected/test_TwoVisitors_twoWebsites_differentDays_Conversions_Goals.getDaysToConversion_firstSite_lastN__API.getProcessedReport_day.xml b/tests/PHPUnit/System/expected/test_TwoVisitors_twoWebsites_differentDays_Conversions_Goals.getDaysToConversion_firstSite_lastN__API.getProcessedReport_day.xml index 5ead103051..d733732a84 100644 --- a/tests/PHPUnit/System/expected/test_TwoVisitors_twoWebsites_differentDays_Conversions_Goals.getDaysToConversion_firstSite_lastN__API.getProcessedReport_day.xml +++ b/tests/PHPUnit/System/expected/test_TwoVisitors_twoWebsites_differentDays_Conversions_Goals.getDaysToConversion_firstSite_lastN__API.getProcessedReport_day.xml @@ -8,6 +8,7 @@ <module>Goals</module> <action>getDaysToConversion</action> <dimension>Days to Conversion</dimension> + <documentation>This report shows how many days pass before your visitors convert a goal.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> <metrics> <nb_conversions>Conversions</nb_conversions> diff --git a/tests/PHPUnit/System/expected/test_TwoVisitors_twoWebsites_differentDays_Conversions_MultiSites.getAll_firstSite_lastN__API.getProcessedReport_day.xml b/tests/PHPUnit/System/expected/test_TwoVisitors_twoWebsites_differentDays_Conversions_MultiSites.getAll_firstSite_lastN__API.getProcessedReport_day.xml index c45e075247..109e6fb23b 100644 --- a/tests/PHPUnit/System/expected/test_TwoVisitors_twoWebsites_differentDays_Conversions_MultiSites.getAll_firstSite_lastN__API.getProcessedReport_day.xml +++ b/tests/PHPUnit/System/expected/test_TwoVisitors_twoWebsites_differentDays_Conversions_MultiSites.getAll_firstSite_lastN__API.getProcessedReport_day.xml @@ -8,6 +8,7 @@ <module>MultiSites</module> <action>getAll</action> <dimension>Website</dimension> + <documentation>This report gives you an informational overview for each of your websites, containing the most general metrics about your visitors.</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_actions>Actions</nb_actions> diff --git a/tests/PHPUnit/System/expected/test_TwoVisitors_twoWebsites_differentDays_VisitFrequency.get_firstSite_lastN__API.getProcessedReport_day.xml b/tests/PHPUnit/System/expected/test_TwoVisitors_twoWebsites_differentDays_VisitFrequency.get_firstSite_lastN__API.getProcessedReport_day.xml index e1323cb324..80df1b28b0 100644 --- a/tests/PHPUnit/System/expected/test_TwoVisitors_twoWebsites_differentDays_VisitFrequency.get_firstSite_lastN__API.getProcessedReport_day.xml +++ b/tests/PHPUnit/System/expected/test_TwoVisitors_twoWebsites_differentDays_VisitFrequency.get_firstSite_lastN__API.getProcessedReport_day.xml @@ -8,6 +8,7 @@ <name>Returning Visits</name> <module>VisitFrequency</module> <action>get</action> + <documentation>This report shows general metrics like visits for returning visitors side by side with the same metrics for new visitors. Learn how returning visitors perform overall compared to new visitors.</documentation> <metrics> <nb_visits_returning>Returning Visits</nb_visits_returning> <nb_actions_returning>Actions by Returning Visits</nb_actions_returning> diff --git a/tests/PHPUnit/System/expected/test_TwoVisitors_twoWebsites_differentDays_VisitsSummary.get_firstSite_lastN__API.getProcessedReport_day.xml b/tests/PHPUnit/System/expected/test_TwoVisitors_twoWebsites_differentDays_VisitsSummary.get_firstSite_lastN__API.getProcessedReport_day.xml index cd964f981f..ec2d3adaf1 100644 --- a/tests/PHPUnit/System/expected/test_TwoVisitors_twoWebsites_differentDays_VisitsSummary.get_firstSite_lastN__API.getProcessedReport_day.xml +++ b/tests/PHPUnit/System/expected/test_TwoVisitors_twoWebsites_differentDays_VisitsSummary.get_firstSite_lastN__API.getProcessedReport_day.xml @@ -8,6 +8,7 @@ <name>Visits Summary</name> <module>VisitsSummary</module> <action>get</action> + <documentation>This report provides a very general overview of how your visitors behave.</documentation> <metrics> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> <nb_visits>Visits</nb_visits> diff --git a/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getGlossaryReports.xml b/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getGlossaryReports.xml index 622d25675b..a2e62006ff 100644 --- a/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getGlossaryReports.xml +++ b/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getGlossaryReports.xml @@ -1,10 +1,22 @@ <?xml version="1.0" encoding="utf-8" ?> <result> <row> + <name>Actions - Main metrics (Actions)</name> + <documentation>This report provides a very basic overview of what actions your visitors take on your website.</documentation> + </row> + <row> + <name>Advanced tag cloud: with logos and links (UI Framework)</name> + <documentation>This report shows a sample tab cloud.</documentation> + </row> + <row> <name>All Channels (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>All Websites dashboard (All Websites)</name> + <documentation>This report gives you an informational overview for each of your websites, containing the most general metrics about your visitors.</documentation> + </row> + <row> <name>Browser Plugins (Visitors)</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> @@ -17,10 +29,14 @@ <documentation>This report shows which language the visitor's browsers are using. (e.g. "English")</documentation> </row> <row> - <name>Browsers (Visitors)</name> + <name>Browser version (Visitors)</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>Browsers (Visitors)</name> + <documentation>This report contains information about what kind of browser your visitors were using.</documentation> + </row> + <row> <name>Campaigns (Referrers)</name> <documentation>This report shows which campaigns led visitors to your website.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-campaigns/</onlineGuideUrl> @@ -38,6 +54,16 @@ <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>Content Name (Actions)</name> + <documentation>This report shows the names of the content your visitors viewed and interacted with.</documentation> + <onlineGuideUrl>https://matomo.org/docs/content-tracking/</onlineGuideUrl> + </row> + <row> + <name>Content Piece (Actions)</name> + <documentation>This report shows the pieces of content your visitors viewed and interacted with.</documentation> + <onlineGuideUrl>https://matomo.org/docs/content-tracking/</onlineGuideUrl> + </row> + <row> <name>Continent (Visitors)</name> <documentation>This report shows which continent your visitors were in when they accessed your website.</documentation> </row> @@ -51,6 +77,27 @@ <onlineGuideUrl>https://matomo.org/docs/custom-variables/</onlineGuideUrl> </row> <row> + <name>Data tables (UI Framework)</name> + <documentation>This is an example documentation of a report.</documentation> + </row> + <row> + <name>Days to Conversion (Goals)</name> + <documentation>This report shows how many days pass before your visitors convert a goal.</documentation> + <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> + </row> + <row> + <name>Device brand (Visitors)</name> + <documentation>This report shows the brands / manufacturers of the devices your visitors were using. In most cases this information is only available for non-desktop devices.</documentation> + </row> + <row> + <name>Device model (Visitors)</name> + <documentation>This report shows the devices your visitors are using. Each model is displayed combined with the device brand as some model names are used by multiple brands.</documentation> + </row> + <row> + <name>Device type (Visitors)</name> + <documentation>This report shows the types of devices your visitors were using. This report will always show all device types Matomo is able to detect, even if there were no visits with a specific type.</documentation> + </row> + <row> <name>Downloads (Actions)</name> <documentation>In this report, you can see which files your visitors have downloaded. <br /> What Matomo counts as a download is the click on a download link. Whether the download was completed or not isn't known to Matomo.</documentation> </row> @@ -63,6 +110,21 @@ <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 their visit. <br /> The entry URLs are displayed as a folder structure.<br />Use the plus and minus icons on the left to navigate.</documentation> </row> <row> + <name>Event Actions (Actions)</name> + <documentation>This report shows you the number of times each event action occurred. You can view the event categories and names that were tracked along with each event action in the row's subtable. You can change which is shown by changing the secondary dimension with the link at the bottom of the report.</documentation> + <onlineGuideUrl>https://matomo.org/docs/event-tracking/</onlineGuideUrl> + </row> + <row> + <name>Event Categories (Actions)</name> + <documentation>This report shows the categories of each tracked event and how many times they occurred. You can view the event actions and names that were tracked along with each event category in each row's subtable. You can change which is shown by changing the secondary dimension with the link at the bottom of the report.</documentation> + <onlineGuideUrl>https://matomo.org/docs/event-tracking/</onlineGuideUrl> + </row> + <row> + <name>Event Names (Actions)</name> + <documentation>This report shows you the names associated with each tracked event and how many times they occurred. You can view the event actions and categories that were tracked along with each event name in each row's subtable. You can change which is shown by changing the secondary dimension with the link at the bottom of the report.</documentation> + <onlineGuideUrl>https://matomo.org/docs/event-tracking/</onlineGuideUrl> + </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> @@ -71,6 +133,61 @@ <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 their visit. <br /> The exit URLs are displayed as a folder structure.<br />Use the plus and minus icons on the left to navigate.</documentation> </row> <row> + <name>Goal 1 - Thank you - Days to Conversion (Goals)</name> + <documentation>This report shows how many days pass before your visitors convert a goal.</documentation> + <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> + </row> + <row> + <name>Goal 1 - Thank you - Visits to Conversion (Goals)</name> + <documentation>This report shows the number of visits made before a visitor converts a goal.</documentation> + <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> + </row> + <row> + <name>Goal 2 - Hello - Days to Conversion (Goals)</name> + <documentation>This report shows how many days pass before your visitors convert a goal.</documentation> + <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> + </row> + <row> + <name>Goal 2 - Hello - Visits to Conversion (Goals)</name> + <documentation>This report shows the number of visits made before a visitor converts a goal.</documentation> + <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> + </row> + <row> + <name>Goal Goal 1 - Thank you (Goals)</name> + <documentation>This report gives an overview of how well your visitors convert a specific goal.</documentation> + <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> + </row> + <row> + <name>Goal Goal 2 - Hello (Goals)</name> + <documentation>This report gives an overview of how well your visitors convert a specific goal.</documentation> + <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> + </row> + <row> + <name>Goal triggered js (Goals)</name> + <documentation>This report gives an overview of how well your visitors convert a specific goal.</documentation> + <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> + </row> + <row> + <name>Goals (Goals)</name> + <documentation>This report gives an overview of how well your visitors convert a specific goal.</documentation> + <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> + </row> + <row> + <name>Goals Overview (Goals)</name> + <documentation>This report gives an overview of how well your visitors convert a specific goal.</documentation> + <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> + </row> + <row> + <name>Goals Overview - Days to Conversion (Goals)</name> + <documentation>This report shows how many days pass before your visitors convert a goal.</documentation> + <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> + </row> + <row> + <name>Goals Overview - Visits to Conversion (Goals)</name> + <documentation>This report shows the number of visits made before a visitor converts a goal.</documentation> + <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> + </row> + <row> <name>Keywords (Referrers)</name> <documentation>This report shows which keywords users were searching for before they were referred to your website. <br /><br /> By clicking on a row in the table, you can see the distribution of search engines that were queried for the keyword.<br /><br />Note: This report lists most keywords as not defined, because most search engines do not send the exact keyword used on the search engine.</documentation> </row> @@ -83,6 +200,18 @@ <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.<br />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>Main metrics (API)</name> + <documentation>This report gives you an overview over the most important metrics across all categories and plugins.</documentation> + </row> + <row> + <name>Operating System families (Visitors)</name> + <documentation>This report shows you the operating systems your visitors are using grouped by operating system family. An operating system family consists of different versions or distributions.</documentation> + </row> + <row> + <name>Operating System versions (Visitors)</name> + <documentation>This report shows you the operating systems your visitors are using. Each version and distribution is shown separately.</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).<br />Use the plus and minus icons on the left to navigate.</documentation> </row> @@ -109,10 +238,31 @@ <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.<br />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>Performance overview (Actions)</name> + <documentation>This report provides an overview of how fast your webpages become visible to your visitors. This includes both how long it takes for browsers to download your webpages and how long it takes for browsers to display them.</documentation> + <onlineGuideUrl>https://matomo.org/faq/how-to/how-do-i-see-page-performance-reports/</onlineGuideUrl> + </row> + <row> + <name>Pie graph (UI Framework)</name> + <documentation>This report shows a sample Pie chart</documentation> + </row> + <row> + <name>Referrers Overview (Referrers)</name> + <documentation>This report shows what acquisition channels your visitors used to get to your website, and the number of visits each channel type is responsible for.</documentation> + </row> + <row> <name>Region (Visitors)</name> <documentation>This report shows which region your visitors were in when they accessed your website.<br/>In order to see data for this report, you must setup GeoIP in the Geolocation admin tab. The commercial <a rel="noreferrer noopener" target="_blank" href="http://www.maxmind.com/?rId=piwik">Maxmind</a> GeoIP databases are more accurate than the free ones. To see how accurate they are, click <a rel="noreferrer noopener" target="_blank" href="http://www.maxmind.com/en/city_accuracy?rId=piwik">here</a>.</documentation> </row> <row> + <name>Returning Visits (Actions)</name> + <documentation>This report shows general metrics like visits for returning visitors side by side with the same metrics for new visitors. Learn how returning visitors perform overall compared to new visitors.</documentation> + </row> + <row> + <name>Screen Resolution (Visitors)</name> + <documentation>This report shows the screen resolutions your visitors used when viewing your website.</documentation> + </row> + <row> <name>Search Categories (Actions)</name> <documentation>This report lists the Categories that visitors selected when they made a Search on your website.<br/>For example, Ecommerce websites typically have a "Category" selector so that visitors can restrict their searches to all products in a specific Category.</documentation> <onlineGuideUrl>https://matomo.org/docs/site-search/</onlineGuideUrl> @@ -127,6 +277,10 @@ <onlineGuideUrl>https://matomo.org/docs/site-search/</onlineGuideUrl> </row> <row> + <name>Single Website dashboard (All Websites)</name> + <documentation>This report gives you an informational overview for a specific website, containing the most general metrics about your visitors.</documentation> + </row> + <row> <name>Site Search Keywords (Actions)</name> <documentation>This report lists the Search Keywords that visitors searched for on your internal Search Engine.<br/><br/>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.</documentation> <onlineGuideUrl>https://matomo.org/docs/site-search/</onlineGuideUrl> @@ -136,6 +290,18 @@ <documentation>In this table, you can see which websites referred visitors to your site. <br /> By clicking on a row in the table, you can see which URLs the links to your website were on.</documentation> </row> <row> + <name>Temperatures evolution over time (UI Framework)</name> + <documentation>This is an example evolution report</documentation> + </row> + <row> + <name>User IDs (Visitors)</name> + <documentation>This report shows visits and other general metrics for every individual User ID.</documentation> + </row> + <row> + <name>Visits Summary (Visitors)</name> + <documentation>This report provides a very general overview of how your visitors behave.</documentation> + </row> + <row> <name>Visits by Day of Week (Visitors)</name> <documentation>This graph shows the number of visits your website received on each day of the week.</documentation> </row> @@ -156,7 +322,22 @@ <documentation>This graph shows what time it was in the <strong> server's time zone </strong> during the visits.</documentation> </row> <row> + <name>Visits to Conversion (Goals)</name> + <documentation>This report shows the number of visits made before a visitor converts a goal.</documentation> + <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> + </row> + <row> <name>Websites (Referrers)</name> <documentation>In this table, you can see which websites referred visitors to your site. <br /> By clicking on a row in the table, you can see which URLs the links to your website were on.</documentation> </row> + <row> + <name>triggered js - Days to Conversion (Goals)</name> + <documentation>This report shows how many days pass before your visitors convert a goal.</documentation> + <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> + </row> + <row> + <name>triggered js - Visits to Conversion (Goals)</name> + <documentation>This report shows the number of visits made before a visitor converts a goal.</documentation> + <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> + </row> </result>
\ No newline at end of file diff --git a/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getReportMetadata_day.xml b/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getReportMetadata_day.xml index b3b4875076..78903904b3 100644 --- a/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getReportMetadata_day.xml +++ b/tests/PHPUnit/System/expected/test_apiGetReportMetadata__API.getReportMetadata_day.xml @@ -6,6 +6,7 @@ <module>MultiSites</module> <action>getAll</action> <dimension>Website</dimension> + <documentation>This report gives you an informational overview for each of your websites, containing the most general metrics about your visitors.</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_actions>Actions</nb_actions> @@ -39,6 +40,7 @@ <module>MultiSites</module> <action>getOne</action> <dimension>Website</dimension> + <documentation>This report gives you an informational overview for a specific website, containing the most general metrics about your visitors.</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_actions>Actions</nb_actions> @@ -72,6 +74,7 @@ <name>Visits Summary</name> <module>VisitsSummary</module> <action>get</action> + <documentation>This report provides a very general overview of how your visitors behave.</documentation> <metrics> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> <nb_visits>Visits</nb_visits> @@ -338,6 +341,7 @@ <module>DevicesDetection</module> <action>getType</action> <dimension>Device type</dimension> + <documentation>This report shows the types of devices your visitors were using. This report will always show all device types Matomo is able to detect, even if there were no visits with a specific type.</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> @@ -377,6 +381,7 @@ <module>DevicesDetection</module> <action>getModel</action> <dimension>Device model</dimension> + <documentation>This report shows the devices your visitors are using. Each model is displayed combined with the device brand as some model names are used by multiple brands.</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> @@ -416,6 +421,7 @@ <module>DevicesDetection</module> <action>getBrand</action> <dimension>Device brand</dimension> + <documentation>This report shows the brands / manufacturers of the devices your visitors were using. In most cases this information is only available for non-desktop devices.</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> @@ -455,6 +461,7 @@ <module>Resolution</module> <action>getResolution</action> <dimension>Resolution</dimension> + <documentation>This report shows the screen resolutions your visitors used when viewing your website.</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> @@ -495,6 +502,7 @@ <module>DevicesDetection</module> <action>getOsVersions</action> <dimension>Operating system version</dimension> + <documentation>This report shows you the operating systems your visitors are using. Each version and distribution is shown separately.</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> @@ -535,7 +543,7 @@ <module>DevicesDetection</module> <action>getBrowsers</action> <dimension>Browser</dimension> - <documentation>This report contains information about what kind of browser your visitors were using. Each browser version is listed separately.</documentation> + <documentation>This report contains information about what kind of browser your visitors were using.</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> @@ -582,6 +590,7 @@ <module>DevicesDetection</module> <action>getBrowserVersions</action> <dimension>Browser version</dimension> + <documentation>This report contains information about what kind of browser your visitors were using. Each browser version is listed separately.</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> @@ -663,6 +672,7 @@ <module>DevicesDetection</module> <action>getOsFamilies</action> <dimension>Operating system family</dimension> + <documentation>This report shows you the operating systems your visitors are using grouped by operating system family. An operating system family consists of different versions or distributions.</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> @@ -880,6 +890,7 @@ <module>UserId</module> <action>getUsers</action> <dimension>UserId</dimension> + <documentation>This report shows visits and other general metrics for every individual User ID.</documentation> <metrics> <label>Label</label> <nb_visits>Visits</nb_visits> @@ -955,6 +966,7 @@ <name>Actions - Main metrics</name> <module>Actions</module> <action>get</action> + <documentation>This report provides a very basic overview of what actions your visitors take on your website.</documentation> <metrics> <nb_pageviews>Pageviews</nb_pageviews> <nb_uniq_pageviews>Unique Pageviews</nb_uniq_pageviews> @@ -1406,6 +1418,7 @@ <module>Events</module> <action>getCategory</action> <dimension>Event Category</dimension> + <documentation>This report shows the categories of each tracked event and how many times they occurred. You can view the event actions and names that were tracked along with each event category in each row's subtable. You can change which is shown by changing the secondary dimension with the link at the bottom of the report.</documentation> <onlineGuideUrl>https://matomo.org/docs/event-tracking/</onlineGuideUrl> <dimensions> <Events_EventCategory>Event Category</Events_EventCategory> @@ -1441,6 +1454,7 @@ <module>Events</module> <action>getAction</action> <dimension>Event Action</dimension> + <documentation>This report shows you the number of times each event action occurred. You can view the event categories and names that were tracked along with each event action in the row's subtable. You can change which is shown by changing the secondary dimension with the link at the bottom of the report.</documentation> <onlineGuideUrl>https://matomo.org/docs/event-tracking/</onlineGuideUrl> <dimensions> <Events_EventAction>Event Action</Events_EventAction> @@ -1476,6 +1490,7 @@ <module>Events</module> <action>getName</action> <dimension>Event Name</dimension> + <documentation>This report shows you the names associated with each tracked event and how many times they occurred. You can view the event actions and categories that were tracked along with each event name in each row's subtable. You can change which is shown by changing the secondary dimension with the link at the bottom of the report.</documentation> <onlineGuideUrl>https://matomo.org/docs/event-tracking/</onlineGuideUrl> <dimensions> <Events_EventName>Event Name</Events_EventName> @@ -1511,6 +1526,7 @@ <module>Contents</module> <action>getContentNames</action> <dimension>Content Name</dimension> + <documentation>This report shows the names of the content your visitors viewed and interacted with.</documentation> <onlineGuideUrl>https://matomo.org/docs/content-tracking/</onlineGuideUrl> <metrics> <nb_impressions>Impressions</nb_impressions> @@ -1536,6 +1552,7 @@ <module>Contents</module> <action>getContentPieces</action> <dimension>Content Piece</dimension> + <documentation>This report shows the pieces of content your visitors viewed and interacted with.</documentation> <onlineGuideUrl>https://matomo.org/docs/content-tracking/</onlineGuideUrl> <metrics> <nb_impressions>Impressions</nb_impressions> @@ -1635,6 +1652,7 @@ <name>Returning Visits</name> <module>VisitFrequency</module> <action>get</action> + <documentation>This report shows general metrics like visits for returning visitors side by side with the same metrics for new visitors. Learn how returning visitors perform overall compared to new visitors.</documentation> <metrics> <nb_visits_returning>Returning Visits</nb_visits_returning> <nb_actions_returning>Actions by Returning Visits</nb_actions_returning> @@ -1665,6 +1683,7 @@ <name>Performance overview</name> <module>PagePerformance</module> <action>get</action> + <documentation>This report provides an overview of how fast your webpages become visible to your visitors. This includes both how long it takes for browsers to download your webpages and how long it takes for browsers to display them.</documentation> <onlineGuideUrl>https://matomo.org/faq/how-to/how-do-i-see-page-performance-reports/</onlineGuideUrl> <metrics> <avg_time_network>Avg. network time</avg_time_network> @@ -1702,6 +1721,7 @@ <name>Referrers Overview</name> <module>Referrers</module> <action>get</action> + <documentation>This report shows what acquisition channels your visitors used to get to your website, and the number of visits each channel type is responsible for.</documentation> <metrics> <Referrers_visitorsFromSearchEngines>Visitors from Search Engines</Referrers_visitorsFromSearchEngines> <Referrers_visitorsFromSearchEngines_percent>Percent of Visitors from Search Engines</Referrers_visitorsFromSearchEngines_percent> @@ -2214,6 +2234,7 @@ <name>Goals</name> <module>Goals</module> <action>get</action> + <documentation>This report gives an overview of how well your visitors convert a specific goal.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> <metrics> <nb_conversions>Conversions</nb_conversions> @@ -2236,6 +2257,7 @@ <module>Goals</module> <action>getVisitsUntilConversion</action> <dimension>Visits to Conversion</dimension> + <documentation>This report shows the number of visits made before a visitor converts a goal.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> <metrics> <nb_conversions>Conversions</nb_conversions> @@ -2257,6 +2279,7 @@ <module>Goals</module> <action>getDaysToConversion</action> <dimension>Days to Conversion</dimension> + <documentation>This report shows how many days pass before your visitors convert a goal.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> <metrics> <nb_conversions>Conversions</nb_conversions> @@ -2280,6 +2303,7 @@ <parameters> <idGoal>0</idGoal> </parameters> + <documentation>This report gives an overview of how well your visitors convert a specific goal.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> <metrics> <nb_conversions>Conversions</nb_conversions> @@ -2305,6 +2329,7 @@ <idGoal>0</idGoal> </parameters> <dimension>Visits to Conversion</dimension> + <documentation>This report shows the number of visits made before a visitor converts a goal.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> <metrics> <nb_conversions>Conversions</nb_conversions> @@ -2322,6 +2347,7 @@ <idGoal>0</idGoal> </parameters> <dimension>Days to Conversion</dimension> + <documentation>This report shows how many days pass before your visitors convert a goal.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> <metrics> <nb_conversions>Conversions</nb_conversions> @@ -2338,6 +2364,7 @@ <parameters> <idGoal>1</idGoal> </parameters> + <documentation>This report gives an overview of how well your visitors convert a specific goal.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> <metrics> <nb_conversions>Conversions</nb_conversions> @@ -2363,6 +2390,7 @@ <idGoal>1</idGoal> </parameters> <dimension>Visits to Conversion</dimension> + <documentation>This report shows the number of visits made before a visitor converts a goal.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> <metrics> <nb_conversions>Conversions</nb_conversions> @@ -2380,6 +2408,7 @@ <idGoal>1</idGoal> </parameters> <dimension>Days to Conversion</dimension> + <documentation>This report shows how many days pass before your visitors convert a goal.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> <metrics> <nb_conversions>Conversions</nb_conversions> @@ -2396,6 +2425,7 @@ <parameters> <idGoal>2</idGoal> </parameters> + <documentation>This report gives an overview of how well your visitors convert a specific goal.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> <metrics> <nb_conversions>Conversions</nb_conversions> @@ -2421,6 +2451,7 @@ <idGoal>2</idGoal> </parameters> <dimension>Visits to Conversion</dimension> + <documentation>This report shows the number of visits made before a visitor converts a goal.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> <metrics> <nb_conversions>Conversions</nb_conversions> @@ -2438,6 +2469,7 @@ <idGoal>2</idGoal> </parameters> <dimension>Days to Conversion</dimension> + <documentation>This report shows how many days pass before your visitors convert a goal.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> <metrics> <nb_conversions>Conversions</nb_conversions> @@ -2454,6 +2486,7 @@ <parameters> <idGoal>3</idGoal> </parameters> + <documentation>This report gives an overview of how well your visitors convert a specific goal.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> <metrics> <nb_conversions>Conversions</nb_conversions> @@ -2479,6 +2512,7 @@ <idGoal>3</idGoal> </parameters> <dimension>Visits to Conversion</dimension> + <documentation>This report shows the number of visits made before a visitor converts a goal.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> <metrics> <nb_conversions>Conversions</nb_conversions> @@ -2496,6 +2530,7 @@ <idGoal>3</idGoal> </parameters> <dimension>Days to Conversion</dimension> + <documentation>This report shows how many days pass before your visitors convert a goal.</documentation> <onlineGuideUrl>https://matomo.org/docs/tracking-goals-web-analytics/</onlineGuideUrl> <metrics> <nb_conversions>Conversions</nb_conversions> @@ -2510,6 +2545,7 @@ <name>Data tables</name> <module>ExampleUI</module> <action>getTemperatures</action> + <documentation>This is an example documentation of a report.</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> @@ -2541,6 +2577,7 @@ <name>Temperatures evolution over time</name> <module>ExampleUI</module> <action>getTemperaturesEvolution</action> + <documentation>This is an example evolution report</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> @@ -2573,6 +2610,7 @@ <name>Pie graph</name> <module>ExampleUI</module> <action>getPlanetRatios</action> + <documentation>This report shows a sample Pie chart</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> @@ -2605,6 +2643,7 @@ <name>Advanced tag cloud: with logos and links</name> <module>ExampleUI</module> <action>getPlanetRatiosWithLogos</action> + <documentation>This report shows a sample tab cloud.</documentation> <metrics> <nb_visits>Visits</nb_visits> <nb_uniq_visitors>Unique visitors</nb_uniq_visitors> @@ -2636,6 +2675,7 @@ <name>Main metrics</name> <module>API</module> <action>get</action> + <documentation>This report gives you an overview over the most important metrics across all categories and plugins.</documentation> <metrics> <nb_pageviews>Pageviews</nb_pageviews> <nb_uniq_pageviews>Unique Pageviews</nb_uniq_pageviews> diff --git a/tests/PHPUnit/System/expected/test_apiGetReportMetadata_hideMetricsDoc__API.getMetadata_day.xml b/tests/PHPUnit/System/expected/test_apiGetReportMetadata_hideMetricsDoc__API.getMetadata_day.xml index 7e1c898ec6..026302dc29 100644 --- a/tests/PHPUnit/System/expected/test_apiGetReportMetadata_hideMetricsDoc__API.getMetadata_day.xml +++ b/tests/PHPUnit/System/expected/test_apiGetReportMetadata_hideMetricsDoc__API.getMetadata_day.xml @@ -5,6 +5,7 @@ <name>Actions - Main metrics</name> <module>Actions</module> <action>get</action> + <documentation>This report provides a very basic overview of what actions your visitors take on your website.</documentation> <metrics> <nb_pageviews>Pageviews</nb_pageviews> <nb_uniq_pageviews>Unique Pageviews</nb_uniq_pageviews> diff --git a/tests/PHPUnit/System/expected/test_apiGetReportMetadata_hideMetricsDoc__API.getProcessedReport_day.xml b/tests/PHPUnit/System/expected/test_apiGetReportMetadata_hideMetricsDoc__API.getProcessedReport_day.xml index 33f240bdab..0379b24940 100644 --- a/tests/PHPUnit/System/expected/test_apiGetReportMetadata_hideMetricsDoc__API.getProcessedReport_day.xml +++ b/tests/PHPUnit/System/expected/test_apiGetReportMetadata_hideMetricsDoc__API.getProcessedReport_day.xml @@ -7,6 +7,7 @@ <name>Actions - Main metrics</name> <module>Actions</module> <action>get</action> + <documentation>This report provides a very basic overview of what actions your visitors take on your website.</documentation> <metrics> <nb_pageviews>Pageviews</nb_pageviews> <nb_uniq_pageviews>Unique Pageviews</nb_uniq_pageviews> |