A Guide to the Allbound Data Pipeline

Purpose

In this article, Allbound System Admins will learn about the Allbound Data Pipeline and understand what data is available for advanced reporting and analytics in a Business Intelligence (BI) Tool via an Allbound Data Connector.

Introduction

The Allbound Data Pipeline contains data from the Allbound platform. The entity relationship diagram (ERD) below describes the objects that are available along with the relationships between the objects.

Users Table

The Users table contains data from all User records. There is a single user record for each user (based on email) and it contains all data captured during user registration and any data updated via the user profile. User data is typically synced to your CRM, if you have an active integration.

Users Data Definition

The following table outlines the most common fields that may be of interest to you. 

Field	Data Type	Description
oid__id	string	System generated unique ID of the user
legacy_id	int	System generated legacy unique ID of the user
email	string	Email of the user; must be unique
first_name	string	User's first name
last_name	string	User's last name
status	string	User status; must be {active, inactive, pending}
permissions	string	Indicates the user type: either administrator or subscriber. If the the user an administrator then it also contains the admin permissions of the user.
registered_date	string	Date the user registered
modified_date	string	Date the user record was last modified
deleted_date	string	This field is not used.
oid_primary_company_info._id	string	Unique ID of the user's primary company
primary_company_info.legacy_id	int	Unique Legacy ID of the user's primary company
primary_company_info.name	string	Name of the user's primary company
primary_company_info.role	string	Role of the user within their primary company
array_group_relationships	string	Contains an array of all dynamic and static groups associated to the user including the unique group IDs and group name.
array_company_relationships	string	Contains an array of all companies associated to the user including the unique company IDs, company name, the user's role within that company and the primary company indicator; is_primary indicates 1 for the user's primary company
array_mdf_approvers	string	Contains an array of users that have the MDF Approver admin permission.
last_login	string	Date the user last logged into portal
meta.*	varies	Fields that start with "meta." are default and custom fields added to the user object. Meta fields are not detailed in this table since they vary from customer to customer. Navigate to the backend User Forms > Shared Fields to view specific field attributes.

Companies Table

The Companies table contains data from all Company records. There is a single company record per company. Company data is typically synced from your CRM, if you have an active integration. Partner Managers may edit their Company profile in Allbound.

Companies Data Definition

The following table outlines the most common fields that may be of interest to you. 

Field	Data Type	Description
oid__id	string	System generated unique ID of the company
legacy_id	int	System generated legacy unique ID of the company
name	string	Company Name
website	string	Company website
logo	string	Path of the stored logo file
status	string	Company status; must be {active, inactive, pending}
array_settings	string	Contains an array of domains and indicates if the domain is whitelisted for registered; Maps to the Company record > Settings tab
created_at	string	Date the company registered
modified_at	string	Date the company record was last modified
array_users	string	Contains an array of all users associated to the company (including channel account managers)
meta.*	varies	Fields that start with "meta." are default and custom fields added to the Company Admin form. Meta fields are not detailed in this table since they vary from customer to customer. Navigate to Account Settings > Forms > Company Admin form to view specific field attributes.

Groups Table

The Groups table contains data from all Groups records. There is a single group record per group. Static groups are groups where users are manually added. Dynamic groups contain rules that automatically add users that match the rule criteria.

Groups Data Definition

The following table outlines the most common fields that may be of interest to you. 

Field	Data Type	Description
oid__id	string	System generated unique ID of the group
legacy_id	int	System generated legacy unique ID of the group
name	string	Group name
description	string	Optional description of the group
type	string	Type of Group; must be {static, dynamic}
created_at	string	Date the group was created

Actions Table

The Actions table tracks actions performed by users throughout the portal. It captures the user that performed the action, the action taken, the resource the action was acted upon (if applicable), and the timestamp of the action. The Actions table provides an audit log of portal events. 

Field	Data Type	Description
id	int	System generated unique ID of the action
user_id	int	The legacy_id of the user that performed the action
action	string	References the action taken. This is a discrete list of actions tracked in the portal.
resource_id	int	ID of the resource the action was taken against. For example: If the user registered a deal, then the resource_id is the Deal ID If the user viewed content, then the resource_id is the Content ID
timestamp	timestamp	Timestamp of the action (UTC)

Content Insights Table

The Content Insights table tracks user engagement with Content. There is a single row per user record and unique content record combination.

Field	Data Type	Description
id	int	System generated unique ID of the action
owner_id	int	Legacy_id of the user that engaged with content
post_id	int	Content ID
title	string	Content title
url	string	URL of the content
post_type	string	Categorization of content
post_status	string	Content status; must be {draft, publish, archive, future, inherit}
group_access_ids	string	Array of legacy_id of groups that have visibility of this content
company_access_ids	string	Array of legacy_id of companies that have visibility of this content
actions_count	string	Count of actions performed by the user against this content and the Total Actions count
created_at	date	Date the content was created
updated_at	date	Date the content was last updated
last_viewed_at	date	Date the content was last view by the user
sharing	string	Indicates if sharing is enabled for the content; 2 = both 3 = email 4 = social media
co_branding	boolean	Indicates if co-branding is enabled for the content

Deals Table

The Deals table tracks all deals registered. There is a single record per deal.

Field	Data Type	Description
id	int	System generated unique ID of the action
post_date	date	Date the deal was registered
last_updated	date	Date the deal was last updated
estimated_close_date	date	Estimated date the deal will close
author_id	int	User Legacy_ID of the user that submitted the Deal Registration form
owner_id	int	User Legacy_ID of the deal owner; the user assigned to the deal
owner_company_id	int	Company Legacy_ID of the deal owner's company
amount	double	Amount of the deal
status	string	Deal stage
normalized_status	string	Status of the deal normalized for consistency across Allbound; Navigate to Revenue Settings > Deal Settings > Mappings to view the 'status' field values mapped to the normalized Allbound statuses
customer_company	string	Prospect company name
crm_id	string	ID of the deal in the CRM
name	string	Deal name
customer_phone	string	Prospect phone number
close_date	string	Actual close date of the deal
ab_second_partner	int	Company Legacy_ID of the second partner if Multi-Tier Distribution is enabled
meta.*	varies	Fields that start with "meta." are default and custom fields added to the Deal Registration form. Meta fields are not detailed in this table since they vary from customer to customer. Navigate to Account Settings > Forms > Deal Registration form to view specific field attributes.