New report 'Personal settings > Custom Variables' displays custom variable usage #9143
Conversation
tsteur
added
not-in-changelog
tsteur
changed the title
| @@ -6,6 +6,16 @@ | |||
| "CustomVariablesReportDocumentation": "This report contains information about your Custom Variables. Click on a variable name to see the distribution of the values. %s For more information about Custom Variables in general, read the %sCustom Variables documentation on piwik.org%s", | |||
| "PluginDescription": "Custom Variables are (name, value) pairs that you can assign using the Javascript API to visitors or any of their action. Piwik will then report how many visits, pages, conversions for each of these custom names and values. View the detailed Custom Variables for each user and action in the Visitor Log.<br />Required to use <a href=\"http://piwik.org/docs/ecommerce-analytics/\">Ecommerce Analytics</a> feature!", | |||
| "ScopePage": "scope page", | |||
| "ScopeVisit": "scope visit" | |||
| "ScopeVisit": "scope visit", | |||
| "ManageDescription": "This overview shows all custom variable slots and their usages. The names within each slot are ordered by how often they were used in total.", | |||
There was a problem hiding this comment.
Could you add the name of the website so it is clear that this report depends on website selected eg. This overview shows all custom variable slots and their usages for %s.
👍 when showing the values in our public API we should aim to make them correct so users don't get disappointed Feedback:
|
|
Done apart from "Could we add a sentence to explain that this report's data will be populated over time after the upgrade to Piwik 2.15.0?" Not sure about this one as it would be there kinda forever even though data might be populated. We could maybe show it in the help text but there not many people would see it. |
Could we maybe display the notification when:
This way, users will know that UI is not broken but that it will take a day or two to fill in (and a few weeks to be fully accurate) |
|
Done. I would have added a test for it but it's not trivial and not really worth it |
|
Looks great! 👍 to merge (couldn't directly merge as there are conflicts) |
tsteur
force-pushed
the
customvar_manage
branch
from
f47bf2a
to
bb84ed8
Compare
Added screen and API to see custom variable usages
mattab
changed the title
mattab
changed the title
mattab
added
the
Major
|
Documented this nice feature in a small section in the Custom Variables user guide |
Shows which custom variable slots are used and which ones aren't. This is useful if you want to get an overview of all used custom variable names and slots and to see which slots are unused. It currently shows all usages, even the one that were used only once or fake once. We could maybe add a parameter later to filter these usages.
There are 2 failing system tests where
idsubdatatableis increased now: https://travis-ci.org/piwik/piwik/jobs/88684701#L613 Not sure why this is the case and how this is related. I did not just want to update the expected xml. Maybe someone has an idea?Another system test is failing re Anonymous tracking plugin. We should fix this test once we merge or once it is good to merge. I did not want to add a new expected file to the plugin in case we rename the API method.
Needed Access
Currently,
Adminaccess is required to request API to get usages of slots and to see the "Custom Variables" page but we could maybe as well allow it forViewaccess? TheAdd new custom variablebutton would need to be made only visible for super users then.Known issue:
The API output is incomplete for any aggregated reports (
range,year, ...) since aggregating metadata is not supported yet. It only uses the metadata of the row having the most actions/visits: https://github.com/piwik/piwik/blob/2.15.0/core/DataTable/Row.php#L520Example: One day you use a certain custom variable in slot 1, the next day in slot 2. It would only show the usage of the slot having more actions or visits. Not both slot 1 and 2.
Ideally it would combine all scopes (unique). Should I work on that or is it alright?