Woopra Documentation

Configuring Your Schema

Overview

Schemas are the skeleton of your Woopra project. Schema define how the data you track is read and processed by Woopra. Your Schema configuration for all action and visitor data tells Woopra what type of data it is, how you want it to be displayed, and how it can be aggregated.

Schema define the type of actions and visitor data you are tracking, and the type and aggregation you set for each property will be leveraged for smart filtering and richer analytics throughout Woopra.

Basic Schema are automatically created from any custom actions and visitor properties being tracked, or Integrations Apps’ actions that you select from the configuration. Once added, they should be configured as desired by the user who set up the tracking code.

To access the Schema editor, you must be an Administrator. First, you must click on the “Configure” button in your navigation bar and find Action and Visitor Schemas under the Manage section of the sidebar.

There are two types of Schema:

  • Visitor Schema
  • Action Schema

Visitor Schema

Visitor Schema allow you to define the custom visitor properties that you are tracking. The name, email, and company name are added to your Visitor Data Schema by default, but Woopra will also add Schema for the other custom visitor data you are sending. To learn more about how to identify your visitors and track custom visitor data, please read the Javascript tracking tutorial.

For each Schema, you will need to define the title, description, key, type and aggregation:

Schema Property
Description

Title

The Visitor Property title as seen throughout Woopra. This helps your other users understand the property being tracked, even if they did not participate in the setup. e.g. User ID

Description

The description is an important reference for your entire team to understand the meaning of the visitor property, especially those who did not participate in the tracking code setup. It’s always a good practice to add a description to fields to make it easy for other users to take action on this data.

Key

The key name as tracked on your website. This comes directly from your tracking code. e.g. company size

Type

Type of the property:

  • Text – For any string value.
  • Number – For numbers/decimals.
  • Timestamp – For dates. Note that these should be sent in milliseconds rather than seconds.

Aggregation

Specify whether the property is a unique value (A property you wish to track, but do not wish to visualize graphically e.g. account_id), amount (e.g. monetary value), or group (value that could be shared with other customers and that you wish to see in a report e.g. trial, package, etc.).

Action Schema

The Action Schema is different from the Visitor Schema. It defines the actions from your installed Integrations Apps or the actions you’ve set up for tracking and any properties associated with those actions. Each company has their own key events that need to be tracked. For an e-commerce website, you may want to track product views, cart updates, and purchases while if you’re a SaaS business, you’ll want to track form submissions, signups, trial engagement, conversions, etc. To learn more about how to track custom actions, please read the Javascript tracking tutorial.

Your Action Schema configuration will fine tune the look and feel of Woopra for your company. Woopra will use the Schema to build the content of your Profiles (instead of “Visitor did action payment”, it would say “Jim purchased the Yearly Small Business package for $1,999.50“) and more.

Each action consists of three parts to be configured:

Here’s the list of possible icons for a Payment Action Schema:

Action Info

Title

The action name as seen throughout Woopra. This helps your other users understand the action being tracked, even if they did not participate in the setup. You can also associate an icon with the action you’re tracking.

Description

The description is an important reference for your entire team to understand the meaning of this action, especially those who did not participate in the tracking code setup. It’s always a good practice to add a description to fields to make it easy for other agents to act on this data.

Key

The name of the action as it’s tracked e.g payment

Action Properties (each property will have the below fields)

Key

The name of the property as it’s tracked e.g. amount

Type

Types of the properties:

  • Text – For any string value.
  • Number – For numbers/decimals.
  • Timestamp – For dates. Note that these should be sent in milliseconds rather than seconds.

Number and Timestamp types support formats. Text type doesn’t.

Aggregation

Specify whether the property is a unique value, amount, or group.

Action Template

Template

The template for your action defines how it will be displayed in the activity stream of your Profiles. You can add properties to the template from the action ${action.propertyname}, or visitor properties like ${visitor.name}. Below is an example of a template for the signup event:
${visitor.name} signed up to Woopra from ${action.company} (${action.company size})

Aggregations

Group

This is used for properties that can be applied to multiple events or visitors, such as company, product, or credit card type.

Unique

This is used for properties that are a unique identifier for a specific event, such as a receipt ID or a transaction ID. For visitors, a username or email address would be a unique identifier, while company would be a “group” as it can be applied to more than one visitor.

Amount

This is used for properties that can be added up or summed. When you designate a property as “amount”, you will be able to sum it in your segmentation filters and analytics reports.

For example, in the “payment” Action Schema, we can designate the “amount” property as an “amount”. Now when we are using segmentation filters, we may segment for “all customers who have made payments that totaled more than $200”. Similarly, our action report for the “payment” event will include a column which sums the total payment amounts by day, week, or month.

Configuring Your Schema