Innkeepr
Home
  • Home
    • Welcome to Innkeepr
    • Getting Started
  • Guides
    • A Basic Installation
    • Server-Side Installation
  • Connections
    • Overview
    • The Innkeepr Spec
      • Spec: Identify
      • Spec: Track
      • Spec: Ecommerce Events
    • Sources Catalog
      • Innkeepr.js
      • Google Ads
      • Google Analytics 4
      • Meta Ads
      • Shopify
      • TikTok Ads
  • References
    • Audiences
    • Events
      • Standard events
      • Custom events
  • Support
    • Resources
      • Cookie Consent
      • Data Protection Statement
    • FAQ
    • Contact
Powered by GitBook
On this page
  • Installation
  • About Innkeepr.js and other Sources
  • Add conversion tracking
  • Testing and Debugging
  • Audiences
  • Types, Goals & Treatments
  • Creating your first audience
  • Integration
  • Targeting Events
  • Audience Usage Guidelines
  1. Home

Getting Started

PreviousWelcome to InnkeeprNextA Basic Installation

Last updated 26 days ago

Welcome to Innkeepr! This doc walks you through each of the tasks to set up your workspace and become familiar with Innkeepr.

The guide is divided into three sections:

  1. Installation: Set up data sources to send data to Innkeepr.

  2. Audiences: Create your first audiences.

  3. Integration: Support marketing campaigns using your audiences.

Installation

The installation tasks cover how to send and debug your initial data from a Source (a library that sends data to Innkeepr).

Key Installation Tasks:

  • Add Innkeepr.js and Other Sources

  • Add Conversion Tracking

  • Testing and Debugging

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 methods.

Learn More

Install Innkeepr.js

We usually recommend using a custom subdomain (e.g. innkeepr.your_domain.com). That way you will enable a clean first-party tracking with ~30% more sessions being tracked, delivering better results for your audiences.

Learn More

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:

  • Go to Sources.

  • Click Add Source.

  • Enter any information on the setup page.

  • Click Save Source.

Learn More

Add conversion tracking

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 cataloge before implementing Track calls.

Learn More

Testing and Debugging

The Event Debugger is a real-time tool that helps you validate 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:

  • Navigate to Events.

  • Filter incoming events by Type, Name or Payload.

Learn More

  • Testing and Debugging

  • Using the Events Debugger

Audiences

Types, Goals & Treatments

Audiences have a couple of configuration elements you can configure in order to tailor them around your specific needs:

  • Types - we support three audience types: seeds, retargeting and exclusions

  • Goals - the conversion goal you'd want to reach with your audience

  • Treatments - similar historic campaigns the audience initially can learn from

Types

Types help to define the purpose for each audience. We currently support three types:

  • Seed - used for better lookalikes or audience signals

  • Retargeting - used to retarget previous visitors, cart abonders or existing customers

  • Exclusion - used to keep irrelevant traffic away from your site

Types have significant an impact on how audiences are composed with regards to size, sampling and update cycles. Therefore we do not recommend using audiences in not-intented use cases.

Learn More

Goals

Goals define the user action you'd like to reach with your audience. You can use every standard or custom event - from page view to checkout completed - as a potential audience goal.

Learn More

Treatments

Audiences learn through a mechanism called Audience Optimization. It's an approach to learn from traffic of your shop or web app in real-time and compose audiences based on users that are most relevant for specific campaign.

Treatments are a way to initially tailor audiences for specific campaigns. They are an abstract equivalent of what you know as ad sets, asset groups, or ad groups that live in your Google, Meta and TikTok accounts. You can add treatments of a similar existing campaign to an audience during the setup to help the audience learn from historic data.

Learn More

Creating your first audience

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. Chose a Conversion Goal the Audience will be optimized for.

  6. Select the Audience type.

  7. (Optional) Select historic campaigns for initital training data.

  8. Click Create.

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

Integration

Innkeepr allows you to sync audience directly into a variety of marketing tools. This guide will give a more in depth explanation how the sync works and how to use audiences properly across your marketing stack.

Targeting Events

Innkeepr uses events to dynamically compose audiences across your marketing tool stack. These "innkeepr_targeting" events are available on all platforms integrated with Innkeepr.

For each audience, Innkeepr emits separate targeting events, including an individual user ID, (which is Innkeepr's anonymous ID), as well as an audience ID. That way we link a user to a specific audience through an audience event listener, also known as audience rule.

Example:

// sample targeting event
{
    name: "innkeepr_targeting_AUDIENCE_ID"
    user: "USER_ID"
    audience: "AUDIENCE_ID"
}

This process is fully automated, so once an audience is created, Innkeepr begins emitting the relevant targeting events, which can then be seamlessly used in your marketing tools.

Learn More

Audience Usage Guidelines

A few words on audience types

To achieve optimal results, it's essential to use each audience type as intended.

  • Seed Audiences: Primarily used for lookalike creation, identifying relevant users within your audience. An exception is when using seed audiences with Google Performance Max (PMax) campaigns, where they can also enhance targeting.

  • Exclusion Audiences: Designed to filter out users less likely to convert, these should only be used as exclusion lists to improve campaign efficiency by focusing on high-quality prospects.

Using audiences for multiple campaigns

While reusing an audience across different campaigns might seem efficient, Innkeepr’s audience optimization is designed to learn from specific touchpoints created by each campaign.

Reusing audiences across too many campaigns can reduce precision. It’s worth considering a long-term campaign setup that aligns with how audiences are intended to be used to maintain effectiveness.

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 .

Click the Source you’d like to add. Note: More than 80% of workspaces start by adding their JavaScript website (see ).

Conversion events represent key user actions beyond simple page views. 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.

Audiences 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 you can build audiences for customer acquisition, retargeting and spend supression and sync them directly into your marketing channels.

Identify and Track
Innkeepr Spec
Spec: Identify
Spec: Track
basic installation guide
Basic Installation
Server-side Installation
What is a Source?
Sources Catalog
Innkeepr’s Track call
Spec: Track
Standard events
Custom events
Audiences
Spec: Identify
Innkeepr.js
Create a Source
installed Innkeepr.js
Goals
Types
Treatments