Getting Started Guide

The guide is divided into two sections:

1. Basic: These tasks allow you to send and debug your first data through Innkeepr.
2. Instrumentation: These tasks allow you to send data to Innkeepr and provide an introduction to using audience and conversion signals.

​

Basic

The tasks included in Basics help you send and debug your very first data from a Source (a library that sends data to Innkeepr) into Innkeepr’s causal analytics engine. The Basic tasks include:

1. Invite teammates
2. Add a Source
3. Add page or screen tracking
4. Send track events
5. Testing and Debugging

​

Invite Teammates

Innkeepr allows you to invite team members to your workspace. To decide who on your team should be added to Innkeepr, think about who might be responsible for implementing, owning, or using incrementality signals in downstream channels. To invite team members to your workspace:

1. Go to Settings > Workspace Settings and click the User Management tab.
2. Click + Invite Team Member.
3. Enter the email addresses of the team members you want to invite separated by a comma.
4. Click Invite.

​

Add a Source

​

About Innkeepr.js and other Sources

Innkeepr.js is the starting point of every installation. It automatically captures page events from your shop or web app and sends it to the Innkeepr servers.  Additionally, Innkeepr.js provides building blocks for identifying users and capturing conversion events in the form of Identify and Track methods. To install Innkeepr on your site:

​

Install Innkeepr.js

Innkeepr.js can be installed with a custom subdomain or as an external third-party service. A full installation of Innkeepr.js is documented in our basic installation guide. We usually recommend using a custom subdomain (e.g. innkeepr.your_domain.com). That way you will enable clean first-party tracking with ~30% more sessions being tracked, delivering better results for your audiences.

​

Add more Sources

A Source is a website, server library, mobile SDK, or cloud application which can send data to Innkeepr. It’s where your data originates. Add a Source to collect data to understand who your customers are and how they’re using your product. Create a source for each website or app you want to track. To add a Source:

1. Go to Sources.
2. Click Add Source.
3. Click the Source you’d like to add. Note: More than 80% of workspaces start by adding their JavaScript website (see Innkeepr.js).
4. Enter any information on the setup page.
5. Click Save Source.

​

Send track events

Track events represent key user actions beyond simple page views. Innkeepr’s Track call captures these actions along with any relevant properties that describe the behavior. Sending a Track call is essential for building audiences, as Innkeepr’s audiences are specifically tailored around events collected through these calls. Certain Sources (e.g Shopify), automatically implement Track calls for important events, such as checkout_completed or added_to_cart, so you don’t need to set them up manually. We recommend checking out our sources catalog before implementing Track calls.

​

Testing and Debugging

The Event Debugger is a real-time tool that helps you validate that API calls made from your website, mobile app, or servers arrive at Innkeepr. You can use the Event Debugger to make sure that your sources function properly and your events are actively sent. The Raw view is the complete JSON object Innkeepr receives from the calls you send. These calls include all the details about what is tracked: timestamps, properties, traits, IDs, and contextual information Innkeepr automatically collects the moment the data is sent. To access your Source Debugger:

1. Navigate to Events.
2. Filter incoming events by Type, Name or Payload.

​

Instrumentation

The tasks in this phase help you create a data strategy and send additional types of data (identify and track calls) to get a clearer picture of who your users are and what actions they’re taking. Instrumentation

• Send an Identify call
• Send a Track call
• Event anatomy and naming standards
• Create your first audience
• Enable conversion signals

​

Send an Identify call

The Identify call allows you to tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about the user, like their email, name, and address. Sending an Identify call is your first step towards understanding who your users are. An example of the types of details you might want to learn and track about your users in an Identify call are:

• Name
• Email
• Address
• Company
• Lifetime Value

​

Send track events

Track events represent key user actions beyond simple page views. Innkeepr’s Track call captures these actions along with any relevant properties that describe the behavior. Sending a Track call is essential for building audiences, as Innkeepr’s audiences are specifically tailored around events collected through these calls. Certain Sources (e.g Shopify), automatically implement Track calls for important events, such as checkout_completed or added_to_cart, so you don’t need to set them up manually. We recommend checking out our sources catalog before implementing Track calls.

​

Event anatomy and naming standards

When it comes to data collection, the best way to set your company up for success is to establish consistent naming conventions. This makes your code easier to read, and it helps everyone at your company understand what your events mean. Innkeepr recommends the best practice of using an “Object Action” (Noun Verb) naming convention for all Track events (for example, Menu Clicked) and using noun_noun snake case for property names (for example, property_name). You can view all the event names you’re currently tracking in the Schema view to ensure you’re using consistent conventions and casing.

​

Create your first audience

Audience signals are an integral part of Innkeepr. Through audiences you can engage with your most relevant users (or similar ones) across various platforms. After you’ve installed Innkeepr.js, you can build audiences for acquisition, retargeting and spend suppression and sync them directly into your marketing channels. To create an Audience:

1. Go to Audiences.
2. Click Create.
3. Enter a Name.
4. Select the Source the Audience shall be uploaded to.
5. Choose a Conversion Goal the Audience will be optimized for.
6. Select the Audience type.
7. (Optional) Select historic campaigns for initial training data.
8. Click Create.

That’s it. Once created, Innkeepr frequently checks if enough data is available to provide your audience and you will be notified, once the audience has been populated with users within your marketing tool.

​

Enable conversion signals

Conversion signals allow you to stream conversion values adjusted by incremental impact into your ad accounts. After you’ve installed Innkeepr.js and started sending track events to the platform you can create conversion streams and connect them directly into your marketing channels. To stream conversion signals:

1. Go to Signals.
2. Click Create.
3. Enter a Name.
4. Choose a Conversion that will be adjusted. *Note: ensure the conversion event has a revenue field.
5. Select the Source the Conversions shall be uploaded to.
6. Click Create.