Avo
  • About
  • Pricing
  • FAQ
  • Docs
  • 3
    Jobs
  • Login
  • Try Avo for free
  • About
  • Pricing
  • FAQ
  • Docs
  • Jobs
  • Login
  • Try Avo for free

Getting started

Table of Contents

Validate current analytics events

If you are already sending some analytics events from your product and are seeing some potential errors in the data and/or want better confidence in it, then we recommend getting started by using the validateAvoEvent function to validate your current analytics events.

Step 1: Enable the validateAvoEvent function in your desired source

  1. Go to the Connections tab in Avo.
  2. Select the source you want to use the function in.
  3. Turn on the "Event validation function."

Step 2: Generate an Avo.js file (the file name is configurable in the Avo CLI).

Step 3: Import Avo where your analytics calls are passed through:

const Avo = require('./Avo');

Step 4: Add Avo.validateAvoEvent where analytics events are emitted:

Avo.validateAvoEvent({eventName, eventProperties, env: ENVIRONMENT});
argumentdefault valuedescription
eventNamerequiredThe name of the event that is being validated. Example: "Signup Completed"
eventProperties{}The key value pairs of event property names and values. Example {"Singup Method": "Facebook", "Username": "Batman"}
userProperties{}The key value pairs of user property names and values. Example {"Singup Method": "Facebook", "Username": "Batman"}
env"dev"The environment; "dev" for development and "prod" for procuction
stricttrueIf true validation code will throw an error when the validation fails, if false it will only log the error to the console
reportFailureAs"error"Controls log level of validation errors. Defaults to error (console.error), alternative options are e.g. "log" or "warn"

Now all of your analytics calls will be validated against the tracking plan defined in your Avo workspace and will feed the Avo health dashboard with reports for unexpected/invalid events and properties.

Read more about the recommended steps to migrate your current tracking to Avo.

Start tracking new analytics events

If you are not sending many or any analytics events yet - or want to start from scratch we recommend using the custom generated tracking snippets to start sending analytics events without bugs.

  1. Sign up to Avo and create your workspace
  2. Set up your tracking plan by defining the structure of your analytics events
  3. Generate the custome tracking snippets by downloading them from your Avo workspace or using the Avo CLI
  4. Initialize Avo
  5. Implement your analytics events
  6. Enjoy error free product analytics!

Get in touch if you have any questions or would like some help getting started.