[ANALYTICS-205] Default metrics and dimensions for Analytics dashboard Created: 28/Aug/20  Updated: 21/Jan/21  Resolved: 14/Oct/20

Status: Closed
Project: Analytics
Component/s: None
Affects Version/s: None
Fix Version/s: 1.2

Type: Story Priority: Neutral
Reporter: Antti Hietala Assignee: Oanh Thai Hoang
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: 0d
Time Spent: 3.25d
Original Estimate: Not Specified

Issue Links:
Relates
relates to ANALYTICS-227 (205) Add New Widget Closed
dependency
is depended upon by ANALYTICS-224 (227, 205) Add Widget. Preview Closed
is depended upon by ANALYTICS-244 [Investigation] Edit Widget dialog sh... Closed
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Release notes required:
Yes
Documentation update required:
Yes
Date of First Response:
Epic Link: UI/UX Dash improvements
Sprint: Add-Ons 48
Story Points: 8

 Description   

User story:

As a new user, I want to see ready-made widgets in the Analytics app, so that I can get started quickly. I am not familiar with Magnolia or the Analytics app yet. Give me some examples that I can add to my dashboard right away. (widget library)

As a marketer, I want to add common analytics metrics to my dashboard, so that I can follow metrics that I understand. I am not an analytics expert. I know a few basic metrics such as Users and Sessions. (widget builder)

Goals

  • Discover. Help the user discover widgets and metrics. The user doesn’t know what data can be surfaced from connected systems. All web analytics connectors provide universal metrics such as Users (Visitors), Sessions (Visits) and Bounce Rate. Make them available in the library out of the box.
  • Assist. Not all users are analytics experts. Display a short list of common metrics and dimensions first in the widget builder. Don't overwhelm the user. Display friendly labels.

Acceptance criteria

  • AC 1: In the Widget Library, provide ready-made widgets for each data supplier. See https://docs.google.com/spreadsheets/d/1DTOuTBCBh87qJCepR7AemmIDbZMat7ES8y9b2xFFvWk/edit?usp=sharing for default metrics. Each metric is one widget.
  • AC 2: In the Widget Builder, show common metrics and dimensions first at the top in dropdowns. See the list in the spreadsheet. See mockup table below. 
  • AC 3: In the Widget Builder, show less common metrics and dimensions later in dropdowns. Query the API of each data supplier for the complete list.
  • AC 4: In the data supplier YAML configuration, provide a complete list of metric and dimension keys (ga:sessions). If you can't get the friendly labels ("Sessions") from the API, provide them in the YAML file.  
  • AC 5: Show friendly labels such as "Sessions" and "Device Category" in dropdowns. Don't show JSON path expressions as they are too technical.
  • AC 6: Make it clear where the data comes from. Organize or label the widgets according to their data source so that it is easy to see which data comes from Adobe Analytics vs. Google Analytics. We may have customers who use multiple analytics providers simultaneously and they want to compare metrics from many sources.
  • AC7 Default dimension : Last 7 days
     

Example: Metrics dropdown in the widget builder

Metrics
Commonly used
  Users
  Sessions
  Pages / Session
  Average Session Duration
  Bounce Rate
All metrics (in alphabetical order)
  Acquisition
  Avg. Page Download Time
  Goal 1
  Entry Page
  ...

 



 Comments   
Comment by Oanh Thai Hoang [ 12/Nov/20 ]

Hi jlegendre,

Here is the documentation for default metrics and dimension configuration.

By default, if you don't config any special metrics and dimensions in supplier yaml. the default will be used:

For google:

default dimension is "ga:date"

default metrics are  "ga:users", "ga:sessions", "ga:pageviewsPerSession", "ga:avgSessionDuration", "ga:bounceRate"

For matomo:

default dimension is "API.get"

default metrics are  "nb_uniq_visitors", "nb_visits", "nb_actions","sum_visit_length","bounce_rate"

For adobe:

default dimension is "variables/daterangeday"

default metrics are  "metrics/visits", "metrics/visitors", "metrics/pageviews", "metrics/timespentvisit", "metrics/bouncerate"

Just in case user wanna change default metrics or dimension, they can decorate those above default in data supplier yaml.

Ex: I decorated for adobe in adobeDataSupplier.yaml to change default dimension and metrics as below:

  
defaultCommonDimension: variables/daterangeweek

defaultCommonMetrics:
  'metrics/revenue': "metrics/revenue" 
  'metrics/timespentvisit': "metrics/timespentvisit"

# left one is the real id of metric, and second one is i18n key or use real label
Generated at Sun Feb 11 23:16:34 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.