Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add Top Authors goal driver to goal drivers section and side panel #12734

Description

@zutigrm

Feature Description

This follow-up issue adds remaining goal driver - Top Authors for both leads and ecommerce widgets, and includes the proper metadata in registry - title and description so it is listed in Goal drivers section and side panel


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

Acceptance criteria

  • Top Authors Goal Driver is added to the goal drivers registry, with custom dimensions handling (missing custom dimensions for authors error state, gathering custom dimension data)

    • When custom dimension is missing and goal driver is selected it shows warning in side panel per Figma
    • Clicking on setup will follow established custom dimensions flow like how we handle it in KMW selection panel
  • Goal Driver registry includes complete metadata for Top authors Goal Driver.

Implementation Brief

  • Add new goal driver tile assets/js/modules/analytics-4/components/site-goals/goal-drivers/TopAuthorsGoalDriver.tsx

    • Follow same MetricTileTable pattern as existing GoalDrivers; accept only normalized props (rows, loading, error, limit, etc).
    • Fetch author-based report data for ecommerce/lead goal types (you can see example in assets/js/modules/analytics-4/components/widgets/PopularAuthorsWidget.js).
    • Include custom-dimension availability checks so it can surface missing-dimension state predictably.
  • Add Top Authors entry in assets/js/modules/analytics-4/components/site-goals/goal-drivers/registry.ts.

    • Include copyByGoalType metadata with both title and description for ecommerce and lead, using the content from metrics list doc.
  • Ensure Top Authors ID is wired in assets/js/modules/analytics-4/components/site-goals/constants.ts, assets/js/modules/analytics-4/components/site-goals/goal-drivers/types.ts, and relevant exports in assets/js/modules/analytics-4/components/site-goals/goal-drivers/index.ts.

    • Keep ordering and visibility behavior consistent with existing drivers.

Side panel custom dimensions warning + setup flow

  • In Site Goals selection panel components (under assets/js/modules/analytics-4/components/site-goals/selection-panel/), add Top Authors missing-custom-dimension warning UI per Figma when Top Authors is selected.

    • Warning should appear only when selected driver requires author custom dimension and it is unavailable.
  • Reuse KMW custom dimensions setup flow for the warning CTA.

    • When user clicks Setup, trigger the established custom dimensions setup path used in Key Metrics selection panel (adapt into Site Goals feature).
    • Preserve existing loading/error behavior for setup action.

Test Coverage

  • Extend tests for Top Authors registry metadata in registry.test.ts.

    • Verify copyByGoalType.ecommerce and copyByGoalType.lead both include title and description.
  • Add/extend selection panel tests for warning + setup CTA flow.

    • Selecting Top Authors with missing custom dimension shows warning; clicking setup follows KMW-equivalent setup flow.

QA Brief

  • Setup Site Kit, with siteGoals feature flag
  • Use a website with some conversion reporting data (like wexford)
  • Go to site goals widget and open selection panel - verify that Top authors goal driver is present in the list
  • Select Top authors driver:
    • Verify that if you do not have custom dimensions a notice shows in the bottom as per figma
    • When notice is shown:
      • if you did not give edit permissions before, clicking setup CTA will take you to OAuth flow, and upon return create custom dimension and remove the notice
      • If you had given permission, clicking Setup CTA will create custom dimension without OAuth.
  • Once you save the selection verify that top authors driver is added to the goal widget with gathering data message
    • Note that currently custom dimension is not tracked for conversion events yet, that will be implemented later, so we can only see gathering data state, and missing custom dimension with this goal driver

Changelog entry

  • Add Top Authors goal driver to goal drivers section and side panel.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P0High priorityTeam SIssues for Squad 1Type: EnhancementImprovement of an existing feature

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions