Last updated

Insights Data Connector

Brandfolder's Insights Data Connector allows customers to connect directly to their own data. The data is housed in Google BigQuery within a unique Google Cloud Platform (GCP) Project which is established for the customer. The data can be accessed with any existing BigQuery connection method using a GCP account associated with the customer GCP project. The data is refreshed nightly.

Assets CDN Aggregates Events Events with Share Links Events with User Sessions

Schemas

The current version of the Insights Data Connector includes the following schemas, with more tables and columns planned in future versions. These tables exist within the brandfolder dataset in the customer’s GCP project. Each table can be accessed with the path <GCP-project-name>.brandfolder.<table_name>.

Here is an example test query to use, replacing <org-slug> with the slug (unique identifier) for your organization.

SELECT * FROM `bfdc-<org-slug>.brandfolder.assets` LIMIT 1000

Assets

Assets represent the container for attachments/files.

The collections column is an array. For notes on how to query array-type columns in BigQuery, please reference this BigQuery documentation.

availability possible values are: published, unpublished, expired, pending approval.

type possible values are: Color, ExternalMedium, Font, GenericFile, Person, Press, Text.

Note: created_by may contain null values at times. This can be due to guest uploads from users without Brandfolder accounts, files uploaded through bulk migration methods (SFTP, Google Cloud Storage, etc.), or users who have since been hard deleted from the database in adherence with federal data compliance and security constraints.

ColumnData Type
keyString
nameString
descriptionString
brandfolder_keyString
section_nameString
typeString
availabilityString
availability_startTimestamp
availability_endTimestamp
collectionsARRAY (String)
created_atTimestamp
created_byString

Attachments

Attachments are structured data references to unstructured data files.

created_by will contain the user_key of the user who uploaded the latest file to the attachment.

Note: created_by may contain null values at times. This can be due to guest uploads from users without Brandfolder accounts, files uploaded through bulk migration methods (SFTP, Google Cloud Storage, etc.), or users who have since been hard deleted from the database in adherence with federal data compliance and security constraints.

ColumnData Type
keyString
filenameString
asset_keyString
created_atTimestamp
created_byString
sourceString

Brandfolders

privacy possible values are: public, private, stealth.

slug is a unique identifier for your organization.

ColumnData Type
keyString
nameString
slugString
privacyString
created_atTimestamp

CDN Aggregates

This table contains daily aggregates of CDN hits, grouped by object and referrer link.

Objects can either be assets or attachments. It is recommended to join to both assets and attachments when consuming this table to get a full picture of CDN hits.

object_type possible values are: asset, attachment.

ColumnData Type
object_keyString
object_typeString
event_dateDate
referrer_linkString
hit_countInteger
bytes_sumInteger
cdn_linkString
brandfolder_keyString

Collections

privacy can contain three values: public, private, or stealth.

slug is a unique identifier for your organization.

ColumnData Type
keyString
nameString
slugString
privacyString
brandfolder_keyString
created_atTimestamp

Custom Field Values

This table custom field values related to assets.

ColumnData Type
keyString
custom_field_key_nameString
valueString
asset_keyString
created_atTimestamp

Events

This table contains events on objects, where prepositional objects are the location from which the user accessed the object. For example, if a user downloaded an asset from inside a collection, the object would be that asset, and the prepositional object would be the collection.

object_type possible values are: asset, brandfolder, collection.

type possible values are: viewed, downloaded, searched, shared, add_attachments.

prepositional_object_type possible values are: brandfolder, collection, organization, sharelink.

Note when object_type and prepositional_object_type are both set to brandfolder or collection, the respective keys have the same value.

ColumnData Type
keyString
object_keyString
object_typeString
typeString
prepositional_object_keyString
prepositional_object_typeString
brandfolder_keyString
session_keyString
user_keyString
created_atTimestamp

Sessions

This table contains sessions related to events.

ColumnData Type
keyString
anonymousBoolean
emailString
cityString
countryString
created_atTimestamp

Tags

This table contains tags related to assets.

ColumnData Type
keyString
nameString
asset_keyString
auto_generatedBoolean
created_atTimestamp
deleted_atTimestamp

Users

This table contains your users that may be related to events.

saml_teams are common separated when there is more than one.

ColumnData Type
keyString
companyString
countryString
created_atTimestamp
created_with_ssoString
deleted_atTimestamp
departmentString
emailString
first_nameString
last_active_atTimestamp
last_nameString
localeString
saml_teamsString
titleString
updated_atTimestamp

User Permissions

This table contains all of the user permission records each user has within your organization.

permissible_type and permissible_key are used to determine which environment a user has permissions on, e.g., permissible_type = Collection means the user has a collection-level permission, and the permissible_key will be the key for the collection.

Note: A single user may have many permissions assigned to it across environments under your organization.

ColumnData Type
keyString
user_keyString
permission_levelString
created_atTimestamp
updated_atTimestamp
permissible_keyString
permissible_typeString
deleted_atTimestamp

This table contains data about sharelinks related to asset groups.

context_type possible values are: Brandfolder, Collection, Organization.

ColumnData Type
keyString
availability_startTimestamp
availability_endTimestamp
context_typeString
context_brandfolder_keyString
created_atTimestamp
deleted_atTimestamp
nameString
private_linkBoolean
linkString
view_onlyBoolean

This table contains data about sharelinks related to assets.

ColumnData Type
share_link_keyString
asset_keyString