Skip to content

[AnVIL DX] Document catalog analytics requirements and technical design #802

@MillenniumFalconMechanic

Description

Approach

  • Create a function to handle sending events to GA. Specifically, createanalytics.ts in data-explorer-ui/common/analytics (in the data-explorer repo) and add a track function which takes two parameters: eventName and params.
  • Add configurable tracking functionality to existing CTAButton.
  • Track five events that invoke exploreDispatch : table sort, table next page, table previous page, table filter and select entity.
  • Fire tracking after each exploreDispatch call. For example:
exploreDispatch({
        payload: entityListType,
        ....
      });
track(...);
  • Table sort model:
    • Event name: ENTITY_TABLE_SORTED
    • Parameters: ENTITY_NAME, COLUMN_NAME, SORT_DIRECTION
  • Table next/previous page model:
    • Event name: ENTITY_TABLE_PAGINATED
    • Parameters: ENTITY_NAME, PAGINATION_DIRECTION (where PAGINATION_DIRECTION is either NEXT or PREVIOUS)
  • Table filter model:
    • Event name: FILTER_SELECTED
    • Parameters: FILTER_NAME, FILTER_VALUE
  • Select entity model:
    • Event name: ENTITY_SELECTED
    • Parameters: ENTITY_NAME
  • CTA button model:
    • Event name: CTA_BUTTON_CLICKED
    • Parameters: EVENT_NAME
  • See background doc.

Definition of Done

### Tasks
- [ ] https://github.com/clevercanary/data-browser/issues/812
- [ ] https://github.com/clevercanary/data-browser/issues/813
- [ ] https://github.com/clevercanary/data-browser/issues/806
- [ ] https://github.com/clevercanary/data-browser/issues/807
- [ ] https://github.com/clevercanary/data-browser/issues/808
- [ ] https://github.com/clevercanary/data-browser/issues/809
- [ ] https://github.com/clevercanary/data-browser/issues/811
- [ ] https://github.com/clevercanary/data-browser/issues/821
- [ ] https://github.com/clevercanary/data-browser/issues/822
- [ ] https://github.com/clevercanary/data-browser/issues/823
- [ ] https://github.com/clevercanary/data-browser/issues/830
- [ ] https://github.com/clevercanary/data-browser/issues/836
- [ ] https://github.com/clevercanary/data-browser/issues/839
- [ ] https://github.com/clevercanary/data-browser/issues/840

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions