site-kit-wp icon indicating copy to clipboard operation
site-kit-wp copied to clipboard

Update existing ACR tiles to allow for dashboard sharing

Open zutigrm opened this issue 1 year ago • 2 comments

Feature Description

Some of the new ACR metrics are using metrics and dimensions that are not listed within shareable metrics and dimensions. This issue should update it.

See Dashboard Sharing section of the design doc


Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

  • List of shareable metrics is expanded so they can be viewed in view only dashboard. Following new metrics are added:
    • addToCarts
    • eventCount
    • ecommercePurchases
  • List of shareable dimensions is also expanded, by following dimension:
    • eventName
  • Existing ACR KMW are accessible in shared dashboard and data can be read properly.

Implementation Brief

  • [x] Update includes/Modules/Analytics_4/Report/RequestHelpers.php
    • Expand array in validate_shared_metrics method to include metrics listed in the AC
    • Expand array in validate_shared_dimensions method to include dimension listed in the AC
  • Verify that ACR KMW are working in view only access. List of ACR widgets:
    • kmAnalyticsTopPagesDrivingLeads
    • kmAnalyticsTopCitiesDrivingLeads
    • kmAnalyticsTopTrafficSourceDrivingLeads
    • kmAnalyticsTopCitiesDrivingAddToCart
    • kmAnalyticsTopTrafficSourceDrivingAddToCart
    • kmAnalyticsTopCitiesDrivingPurchases
    • kmAnalyticsTopDeviceDrivingPurchases
    • kmAnalyticsTopTrafficSourceDrivingPurchases

Test Coverage

  • No updates needed

QA Brief

  • In the tester plugin, use the https://brainiest-quetzal-9a3cf6.instawp.xyz site as the custom URL. Also, enable conversionReporting feature flag.
  • Connect Analytics as an Admin. Use the above account (ask @zutigrm or @jimmymadon for access).
  • Enable the key metrics plugin.
  • Share the analytics module to other users.
  • Now login as a view only user and select all the metrics in the AC from the selection panel and ensure they all work normally without any errors.

Changelog entry

  • Add Dashboard Sharing support to Analytics Conversion Reporting tiles.

zutigrm avatar Sep 19 '24 12:09 zutigrm

AC looks good.

eugene-manuilov avatar Sep 26 '24 10:09 eugene-manuilov

IB ✅ Moving to EB

10upsimon avatar Oct 01 '24 14:10 10upsimon

QA Update ⚠

  • Tested on dev environment.

  • Tested using https://brainiest-quetzal-9a3cf6.instawp.xyz site.

  • Tested after enabling 'conversionReporting' Feature flag.

  • Compared metrics data for all dates on main and view only dashboard.

  • Verified ACR tiles on both main and view only dashboard.

  • I verified that below listed ACR KMW are working in view only access. (Listed in IB) List of ACR widgets:

    • kmAnalyticsTopPagesDrivingLeads
    • kmAnalyticsTopCitiesDrivingLeads - kmAnalyticsTopTrafficSourceDrivingLeads
    • kmAnalyticsTopCitiesDrivingAddToCart
    • kmAnalyticsTopTrafficSourceDrivingAddToCart
    • kmAnalyticsTopCitiesDrivingPurchases
    • kmAnalyticsTopDeviceDrivingPurchases ??
    • kmAnalyticsTopTrafficSourceDrivingPurchases

@jimmymadon

_Q-1: I am unable to find the ACR KMW widgets mentioned under AC. Are there any widgets with the same name, or are they referring to the same widgets listed under IB?

Q-2: I have verified all ACR KMW widgets except for kmAnalyticsTopDeviceDrivingPurchases. This widget is not listed under the Metrics list. Can you please confirm if the name of this widget is correct?_

Main Dashboard

Image

Image

Image

Image

View only Dashboard

Image

Image

Image

Image

Image

Image

mohitwp avatar Oct 28 '24 13:10 mohitwp

_Q-1: I am unable to find the ACR KMW widgets mentioned under AC. Are there any widgets with the same name, or are they referring to the same widgets listed under IB?

The names in the ACs are that of the metrics and dimensions and not actual widgets. So the widgets within the IB are the ACR widgets that are being displayed.

Q-2: I have verified all ACR KMW widgets except for kmAnalyticsTopDeviceDrivingPurchases. This widget is not listed under the Metrics list. Can you please confirm if the name of this widget is correct?

That is correct - #9162 will add this tile.

jimmymadon avatar Oct 28 '24 14:10 jimmymadon

QA Update ✅

  • Tested on dev environment.

  • Tested using https://brainiest-quetzal-9a3cf6.instawp.xyz site.

  • Tested after enabling 'conversionReporting' Feature flag.

  • Compared metrics data for all dates on main and view only dashboard.

  • Verified ACR tiles on both main and view only dashboard.

  • I verified that below listed ACR KMW are working in view only access. (Listed in IB) List of ACR widgets:

    • kmAnalyticsTopPagesDrivingLeads
    • kmAnalyticsTopCitiesDrivingLeads - kmAnalyticsTopTrafficSourceDrivingLeads
    • kmAnalyticsTopCitiesDrivingAddToCart
    • kmAnalyticsTopTrafficSourceDrivingAddToCart
    • kmAnalyticsTopCitiesDrivingPurchases
    • kmAnalyticsTopTrafficSourceDrivingPurchases

Main Dashboard

Image

Image

Image

Image

View only Dashboard

Image

Image

Image

Image

Image

Image

mohitwp avatar Oct 29 '24 12:10 mohitwp