@chapeaux/cpx-reporter

CPX-REPORTER

Goals

Allow developers and content creators a consolidated mechanism to interact with the Event-Driven Data Layer (EDDL). The ReporterEvent is used to attach meaningful data to the event and forward it on to the Newsdesk listening for event reports. The CPXReporter component is used as a declarative means to listen for specific events or to fire off specific EDDL events automatically.

Installation

• npm install @chapeaux/cpx-reporter
• {FUTURE CDN URL}

Usage

ReporterEvent

• <script type="module" src="path/to/@chapeaux/cpx-reporter/reporter.js"></script>
• import { ReporterEvent } from "path/to/@chapeaux/cpx-reporter/reporter.js";
• <script type="module" data-emit="cpx-report" data-event="Page Load Started" src="path/to/@chapeaux/cpx-reporter/reporter.js"></script>

cpx-reporter

• <script type="module" src="path/to/@chapeaux/cpx-reporter/cpx-reporter.js></script>
• import {CPXReporter} from "path/to/@chapeaux/cpx-reporter/cpx-reporter.js;
• <cpx-reporter debug auto event="Page Load Completed"></cpx-reporter>
• <cpx-reporter event="User Signed In" beat="kc-token-ready">...</cpx-reporter>

Contributing

• Provide feedback on usage
• Submit an issue or PR
• Feature requests flow through CPCORE Jira Project
  • Use "chapeaux" component
  • Priority will be reviewed against all other requests
  • No timeframe promised upon submission

To-Do

• Sync all data structures with formal EDDL declarations

Events

• Page Load Start
• Page Load Complete
• Click Events (using data-analytics-* attributes)
  • Navigation Links
  • Download Links
  • Footer Links
  • Social Links
  • Tab Links
  • Internal Campaign Links
• Form Viewed
• Form Submission Succeeded
• Form Submission Failed
• User Signed In
• User Detected
• Content Listing Displayed
• Content Listing Item Clicked
• Internal Campaign Clicked
• Internal Campaigns Displayed
• CTA Link Clicked
• Download Complete
• Video Started
• Video Milestone Reached
• Video Completed