View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 2259 | Composr | stats | public | 2016-03-05 01:41 | 2022-08-15 15:46 |
| Reporter | Chris Graham | Assigned To | Chris Graham | ||
| Priority | normal | Severity | feature | ||
| Status | resolved | Resolution | fixed | ||
| Summary | 2259: New stats/KPI system | ||||
| Description | This specification is for rewriting the whole Composr CMS stats module into a much more powerful and useful system that makes marketing and line management of staff much more efficient. The new stats would be based around the philosophy of providing diverse context-specific information rather than very advanced Google Analytics-style filtering of generic hit data. We are not trying to replace GA, we are trying to provide something more suitable for quick reference, integrate well with Composr, and provide diverse meaningful data GA cannot. GA will still be better for advanced data analysis by marketing professionals (including split testing, multi-step goal tracking, adsense tracking), and we will still recommend people set up and use GA. For example, we will no longer be breaking down top referrers and browsers on a page-by-page basis, because overall graphs are good enough and easier to access. The new front-end to the admin_stats module would provide a do-next interface with these top level icons: - Google Analytics [if configured] - Performance tracking (line graphs) - Successes (bar charts) - Member map [if Latitude and Longitude CPFs are available] - Defined KPIs [explained further down] - Geo-location data install [if not already installed] - (anything else a hook adds as a new menu item) tut_statistics will continue to be linked from the helper panel. The helper panel should provide a shortcut to the stats configuration in the overview help. Our bespoke SVG graphing system can go, in favour of a http://www.chartjs.org/ solution. If you clicked through to line graphs, you'd then get to choose which graph type to view. Each graph type also has a number of its own settings and shared settings. Shared settings: - From date - To date - Measurement window size (1 day, 1 week, 1 month) [needs to somehow clearly explain this is what it bunches the data up into] The available line graphs, with settings: - Content submission (settings: content type [optional], submitter [optional]) - Tracking-code referrals (settings: tracking code [optional]) [this will need a new table, stats_tracking_codes, populated dynamically; "_t" tracking parameter must be standardised and documented] - Member referrals (settings: referring member [optional]) [this will need a new table, stats_member_referrals, populated dynamically] - Page views (settings: match-key [optional]) - Page views by members per member (settings: only active members [optional], member join recency [optional], match-key [optional]) - Download downloads (settings: download ID [optional]) - Attachment downloads (settings: attachment ID [optional]) [copied daily into stats_aggregate_tracker] - Member accounts - Newsletters sent [this is just a specialisation of admin actions, it can share a base class] - Banner views (settings: banner type SQL wildcard pattern [optional]) [copied daily into stats_aggregate_tracker] - Banner clicks (settings: banner type SQL wildcard pattern [optional]) [copied daily into stats_aggregate_tracker] - Support tickets created - Support tickets open - Alexa ranking (settings: URL [defaults to base URL]) [copied daily into stats_aggregate_tracker] - Google ranking (settings: URL [defaults to base URL], keyword) [copied daily into stats_aggregate_tracker] [use https://developers.google.com/webmaster-tools/v3/how-tos/search_analytics#verify--the-presence-of-data - will work for already-working keywords only] - Website comments - Errors in log [copied daily into stats_aggregate_tracker] - Server CPU load (settings: trough/peak/average [defaults to average]) [trough/peak/average-diffed daily into stats_aggregate_tracker] - Server memory usage (settings: trough/peak/average [defaults to average]) [trough/peak/average-diffed daily into stats_aggregate_tracker] - Server I/O (settings: trough/peak/average [defaults to average]) [trough/peak/average-diffed daily into stats_aggregate_tracker] - Free disk space [copied daily into stats_aggregate_tracker] - Recommendations sent - Poll votes [copied daily into stats_aggregate_tracker] - Quiz entries (settings: quiz ID [optional]) - Points earned [copied daily into stats_aggregate_tracker] - Points earned per member (settings: only active members [optional], member join recency [optional]) [copied daily into stats_aggregate_tracker] - Points gifted [copied daily into stats_aggregate_tracker] - Points gifted per member (settings: only active members [optional], member join recency [optional]) [copied daily into stats_aggregate_tracker] - Newsletter signups [copied daily into stats_aggregate_tracker] - Admin action (settings: action log type [optional]) - eCommerce sales in currency units - eCommerce transaction count - Users online at once [needs better way of logging this] - Rating actions - Rating actions by members per member (settings: only active members [optional], member join recency [optional], match-key [optional]) [copied daily into stats_aggregate_tracker] - Referers detected [need new table, stats_referers] (NB: We may decide to just put everything into stats_aggregate_tracker daily for performance reasons) The available bar charts, with settings: - Incoming search keywords [requires Google Analytics API integration] - Internal search keywords - Slow page-links - Referrer URLs - Demographic ranges - Members by forum posts - Members by points - Members by visits - Hits by IP addresses - User agents - Countries - Content by views (settings: content type [optional], submitter [optional]) - Content by rating (settings: content type [optional], submitter [optional]) - Content by comment count (settings: content type [optional], submitter [optional]) - Forum topics by post count - Website usage by hour - Custom Profile Field list value selection (settings: field title) (think of these as showing the 'top' of each - but you can also paginate through to see the bottom of each) API: https://developers.google.com/analytics/ [Google Analytics] Graphs should have tooltip labels, saying what the data point is and what its value is. For all the line graphs and bar charts we will show pagination underneath, to allow full browsing through the data. The graphs would show the data for the particular segment of the data set you're looking at. It obviously sorts by descending order of the measured quantity. CSV links will continue to show, to allow all the data to be easily downloaded. All data will be shown in the site timezone, and there'll be a label saying as such. New CRON hooks are needed: - Data collectors would run via the CRON system on a daily basis. They would do things like see how much a resource's views had gone up since the last check, and log that figure into the stats_aggregate_tracker table. The data would be collected as close to after midnight on whatever timezone the site is configured to. The individual stats hooks would provide the code that the CRON hook would call (this is referenced further down). - There would be a CRON hook that runs every cycle, logging memory usage, server load, free disk space, and disk IO (if it can get them) to a new stats_server_metrics table. For things that must be aggregated using CRON that you are filtering with a non-default filter, you can only see that filtered data if it is set up as a KPI. You'll get an error message saying as much if you try and do a filter and there's no data available. The entire system will be hook based. No particular graphs will be hard-coded into the admin_stats module anymore. Hooks should handle: - Stat screen hooks: - Extra icon for top level do-next menu - Extra full screen - Bar chart hooks & Line graph hooks: - Provide data for graph - Enumerate possible settings - Gather daily data (i.e. so the CRON hook can call into them) Block caching for all rendered graphs. Any graph would have a "Add as KPI" link under it. These KPIs are added to the system as things to track on an ongoing basis. When added, it would ask for: - a list of username(s) that has responsibility for the KPI - a note - a target figure - whether the target is a differential per week or a differential per month or a flat total - whether that target is a minimum or a maximum KPIs could be deleted from the view KPIs screen. That screen would also show a table ("KPI summary table") of all the KPIs and their settings, the current measurement, the current target, whether it is being passed, and a link to view the full graph. Red would be used to indicate failing KPIs. New staff notifications would be added to the system: - Weekly KPI report (my KPIs) - Weekly KPI report (all KPIs) These would email out the KPI summary table (explained above) on a weekly basis. (The staff checklist report would also include these things, in more-summarised form) The staff checklist block on the Admin Zone dashboard would also summarise all the KPIs, via a simplified read-out compatible with the data already shown there. There would be a new block (main_staff_stats_graph) that could render any particular graph. Webmasters may use this to add lots onto the Admin Zone dashboard screen. There would be another block (main_staff_stats_kpi) that shows all the configured KPI graphs. Peripheral tasks: - The stats table should be redesigned to store "zone:page" rather than the paths of pages - Tear out the old SVG framework we were maintaining - Update the tut_statistics tutorial - Copy archive.org link of main_website_monitoring to "Useful external links" - Remove main_website_monitoring block, and its reference from the Admin Zone dashboard (it overlaps with our new system and we don't need it) - Make sure there's a link to some back-link-finder tool in "Useful external links" - Remove the following main_staff_checklist hooks and associated config options (as these are now re-implementable as KPIs) - newsletter - blog - news - Add a note in http://compo.sr/tracker/view.php?id=1965 that we can potentially implement more stats integration for other services - Decacher script must no longer decache the old .xml files, and any references to them must be removed - Our page stats cleanup hook will need to remove data from some of the new stats tables - Add chartjs references to license file, upstream tracking issues, .editor_config, line_count.sh YouTube addon ------------- Extra line graphs: - YouTube videos posted (settings: Youtube account ID [defaults to configured one]) [copied daily into stats_aggregate_tracker] - YouTube videos comments received (settings: Youtube account ID [defaults to configured one]) [copied daily into stats_aggregate_tracker] - YouTube videos average rating (settings: Youtube account ID [defaults to configured one]) [copied daily into stats_aggregate_tracker] - YouTube videos views (settings: Youtube account ID [defaults to configured one]) [copied daily into stats_aggregate_tracker] - YouTube subscribers (settings: Youtube account ID [defaults to configured one]) [copied daily into stats_aggregate_tracker] Extra bar charts: - Most engaging users on YouTube - Popular videos API: https://developers.google.com/youtube/reporting/#Report_Contents Twitter addon ------------- Extra line graphs: - Tweets made (settings: twitter account name [defaults to configured one]) [copied daily into stats_aggregate_tracker] - Twitter followers (settings: twitter account name [defaults to configured one]) [copied daily into stats_aggregate_tracker] - Twitter mentions (settings: twitter account name [defaults to configured one]) [copied daily into stats_aggregate_tracker] - Twitter retweets (settings: twitter account name [defaults to configured one]) [copied daily into stats_aggregate_tracker] Extra bar charts: - Most engaging users on Twitter - Popular Tweets API: https://dev.twitter.com/rest/public Facebook addon -------------- Extra line graphs: - Facebook posts made (settings: Facebook page ID [defaults to configured one]) [copied daily into stats_aggregate_tracker] - Facebook page likes (settings: Facebook page ID [defaults to configured one]) [copied daily into stats_aggregate_tracker] - Facebook page visits (settings: Facebook page ID [defaults to configured one]) [copied daily into stats_aggregate_tracker] - Facebook reach (settings: Facebook page ID [defaults to configured one]) [copied daily into stats_aggregate_tracker] - Facebook post likes (settings: Facebook page ID [defaults to configured one]) [copied daily into stats_aggregate_tracker] - References on Facebook (settings: domain name [defaults to base URL domain name]) [copied daily into stats_aggregate_tracker] - Links from Facebook (settings: domain name [defaults to base URL domain name]) [copied daily into stats_aggregate_tracker] Extra bar charts: - Most engaging users on Facebook - Popular Facebook posts API: https://developers.facebook.com/docs/platforminsights/page API: https://developers.facebook.com/docs/platforminsights/domains (for references and links) (requires some setup in <head>) Google adsense addon -------------------- Extra line graphs: - Money in account (settings: account ID) API: https://developers.google.com/adsense/management/ Google Play Store addon / Apple Appstore addon ---------------------------------------------- (implemented completely separately for both with name prefixes, but repeated here to avoid copy&pasting) Extra line graphs: - App installs (settings: app ID) [copied daily into stats_aggregate_tracker] - App uninstalls (settings: app ID) [copied daily into stats_aggregate_tracker] - App rating (settings: app ID) [copied daily into stats_aggregate_tracker] - App error reports (settings: app ID) [copied daily into stats_aggregate_tracker] - App store keyword ranking (settings: app ID, keyword) [copied daily into stats_aggregate_tracker] - App store category ranking (settings: app ID, category ID) [copied daily into stats_aggregate_tracker] Extra bar charts: - App demographic ranges (settings: app ID) - App versions (settings: app ID) - iOS/Android version (settings: app ID) - App countries (settings: app ID) - App usage by hour (access details may be needed for settings too, not sure) API: http://docs.appfigures.com/api/reference/v2/sales (meta-data) API: http://docs.appfigures.com/products#searching_for_products (keyword ranking) API: http://docs.appfigures.com/api/reference/v2/ranks (category ranking) | ||||
| Tags | Type: External social media integration | ||||
| Attach Tags | |||||
| Time estimation (hours) | 40 | ||||
| Sponsorship open | |||||
| related to | 3149 | Resolved | Chris Graham | Composr | Improved Google Analytics tracking |
| related to | 603 | Not Assigned | Guest | Composr | Newsletter tracking, include tracking code integration |
| related to | 2980 | Resolved | Chris Graham | Composr documentation | Social media integration review and documentation |
| related to | 1264 | Not Assigned | Guest | Composr | Social media stats |
|
|
Some details on referral tracking... We currently use 'keep_referrer' as a standard for tracking referrals by members. This should be documented in codebook3.txt. These detected referrers would be logged to the stats_member_referrals table. The current 'ad_success' non-bundled addon uses a '_t' parameter for tracking. These detected referrers would be logged to the stats_tracking_codes table. This should be documented into codebook3.txt. HTTP referers would be logged to the stats_referers table. |
|
|
We may also consider an addon for showing email delivery reports via e.g. Elastic Email. Also simple bounce reports, e.g. via Amazon SES. Likely when this issue is implemented some parts of it will be split out into separate issues. |
|
|
Also a note that we could do graphs for affiliate systems such as avantgate, revenue, clicks, conversion rate, etc. |
|
|
I've been thinking about how the Admin Zone dashboard displays. It's overwhelming to people, and some of the stuff on there is dated in that it is over-simple compared to the massive breadth of analytics open to people now. I think probably the staff links should be taken off and moved into links at the bottom of tutorials. There's too much to link to from a single block nowadays. The monitoring block probably should just be removed. I don't think anyone is really using it as currently-is, because people serious are going to go into more detail and lay-users will not even use it. People can use something good like Moz to compare against competitors. I'm not sure if we should keep the block as an option for people. Probably not, probably any integrations would happen under the new analytics system anyway, not the dashboard. |
|
|
Of possible interest is some of the stuff in the Google Search Console API. You can get data on search position for particular keywords. |
|
|
See https://docs.google.com/spreadsheets/d/1_yaJeGzDIsxq33I7Wg9I-lTBDk3YS22WPBwJ971v5tI/ sheet for more ideas about integrations. |
|
|
This is now broadly implemented. There is stuff implemented not discussed here, as I did a clean room reimplementation before checking back over this topic. Some of the implementation details have changed a little. It really is awesome, we have 69 different graphs, most of them supporting some filters. We have split testing. We have a really nice integrated tracking/referrals system. We have a custom-event tracking system. We have a KPI system. We have Google Analytics integration (22 extra graphs from GA can be displayed). We have Google Search Console integration. The following is not implemented and won't be: - Member map (we show a country bar chart instead, member map is a separate non-bundled addon and depends on Google Maps which we don't want in core) - We're focusing more on what happens for sessions (e.g. page views per session), than what an average member does (e.g. page views per member); more useful - Rather than tracking all attachment/download downloads, we have implemented a script that can be used to track any URL access, and also a JavaScript function to track any event -- this allows the webmaster to pinpoint what downloads they actually want to track on their site rather than having a huge amount of noise eating up database space - We won't bother with "Newsletters sent", as it's too specific and we can filter to track any admin action anyway - We'll show banner clicks not banner views, as banner views are just randomised anyway - The banner graph will be filterable by banner name not banner type, as it's the specific banners you want to track performance for - Google ranking will work via Google Search Console API, and show much more than just ranking (but it will be a non-bundled addon and need configuring) - Errors in log, Server CPU load, Server memory usage, Server I/O, Free disk space -- we will not graph these and just leave them to the Health Check system, which can set up alerts on high usage; the timestamp of the alerts will provide the data the sysadmin needs - We'll only show points gifted as a points graph, I don't think we need to see earnings over time - "Rating actions by members per member" is bloaty - "Custom Profile Field list value selection" is not going to fit into the graphing model well (we are really going to show graphs for every CPF by default?) - and already exists elsewhere in Composr with a more appropriate UI - Not showing graph for closed support tickets, bloaty - KPIs will be simplified: - No configurable regular differentials; higher KPIs can be progressively configured via links in the KPI emails - No setting responsibility, it's just a notification that staff will get; responsibility can be handled outside of the scope of Composr - No main_staff_stats_kpi block; staff can add whatever graphs they want to the dashboard manually, and there'll be a link in the staff checklist to view all the KPI graphs - Not removing main_staff_checklist hooks -- as these are a lot easier to use than setting up KPIs, and represent common needs - We're not using block caching when rendering graphs, as it should be fast without it (and makes things a pain to debug) Some differences: - KPI notifications will be sent out based on the timbre of the graph they are for - e.g. KPIs on a monthly graph would have notifications sent monthly - We already have made it so you can easily configure what is on the Admin Zone dashboard in the configuration The third-party integrations in this issue would be implemented separately, if we so desire. They are already on our "Composr external integration" spreadsheet. Right now it only makes sense on a client project where those stats are really important. For reference this issue mentioned: - YouTube - Google adsense - Google Play store / Apple appstore - affiliate systems such as avantgate, revenue, clicks, conversion rate - email delivery reports via e.g. Elastic Email - possible stuff on https://docs.google.com/spreadsheets/d/1_yaJeGzDIsxq33I7Wg9I-lTBDk3YS22WPBwJ971v5tI/ |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2016-03-15 02:31 | Chris Graham | Description Updated | |
| 2016-03-30 18:55 | Chris Graham | Note Added: 0003511 | |
| 2016-03-31 16:39 | Chris Graham | Note Edited: 0003511 | |
| 2016-04-05 02:35 | Chris Graham | Note Added: 0003529 | |
| 2016-12-08 16:12 | Chris Graham | Tag Attached: Type: External social media integration | |
| 2017-03-23 16:20 | Chris Graham | Relationship added | related to 3149 |
| 2017-03-23 16:20 | Chris Graham | Relationship added | related to 603 |
| 2017-05-01 15:01 | Chris Graham | Relationship added | related to 1264 |
| 2017-06-09 19:55 | Chris Graham | Note Edited: 0003401 | |
| 2017-06-09 19:55 | Chris Graham | Description Updated | |
| 2017-09-04 20:11 | Chris Graham | Note Added: 0005192 | |
| 2017-09-04 23:31 | Guest | Note Added: 0005193 | |
| 2018-03-06 05:05 | Chris Graham | Description Updated | |
| 2018-03-06 05:05 | Chris Graham | Relationship added | related to 2980 |
| 2018-03-06 05:06 | Chris Graham | Note Added: 0005548 | |
| 2019-06-27 18:56 | Chris Graham | Tag Attached: Roadmap: v12 | |
| 2020-01-18 03:18 | Chris Graham | Assigned To | => Chris Graham |
| 2020-01-18 03:18 | Chris Graham | Status | Not Assigned => Resolved |
| 2020-01-18 03:18 | Chris Graham | Resolution | open => fixed |
| 2020-01-18 03:18 | Chris Graham | Note Added: 0006288 | |
| 2022-08-15 15:46 | Chris Graham | Tag Detached: Roadmap: v12 |
