Exporting data with S3 logoExporting data with S3

Last updated Aug 28th, 2024

Overview

You can export contact, organization and activity data from Common Room into your data warehouse via our S3 integration. Once you've set up the S3 bucket using the instructions here, our team will work with you to finalize the data contract and set up a regular export.

Data contract

Activity Data

Field nameData typeDescription
activity_timestamp
datetime | null
service_name
string | null
activity_type
string | null 
emails
string | null
comma separated
first_seen_date
datetime | null
primary_email
string | null
profiles
string | null
comma separated
full_name
string | null
city
string | null
member_token
string | null
Identifies the Contact

Contact Data

Field nameData typeNotes
full_name
string | null
primary_email
string | null
profiles
string | null
Comma separated
emails
string | null
first_seen_date
datetime | null
last_seen_date
datetime | null
location
string | null
organizationName
string | null
organizationDomain
string | null
job_title
string | null
sentiment_all_time
float | null
tags
string | null
Comma separated
segment_names
string | null
Comma separated
first_seen_source
string | null
impact_points_all_time
int | null
impact_points
int | null
sentiment
float | null
stat_<source>_<source_name>_<type>
float | null
An entry for each of the statistics. 
source - Channel source e.g. Slack, Discourse, Github, …
source_name - Name of the source
type - type of activity statistic - e.g. replies
member_tokens
string | null
Comma separated list of tokens representing the Contact
<custom_fields>
Dependent on custom field type
An entry for each of the custom fields on the community Contact

Organization Data

Field nameData type
organization_name
string | null
domain
string | null
location
string | null
member_count
int | null
employee_count
int | null
approx_capital_raised
float | null
approx_revenue_min
float | null
approx_revenue_max
float | null
first_seen_date
datetime | null
last_seen_date
datetime | null
first_seen_source
string | null
impact_points_all_time
int | null
sentiment_all_time
float | null
impact_points
int | null
sentiment
float | null
<custom fields>
Dependent on custom field type
An entry for each of the custom fields on the Organization

Details

  • The folder name will be in the following format: data-export/Activity/YYYY/MM/DD/
  • File formats will be in JSONL
  • Marker file name is: _completionmarker_
  • Common Room custom fields map to the following data types, each of which can be nullable.
    • Yes/No - boolean
    • Date - datetime
    • Number - int
    • Single-select - string
    • Multi-select - string
    • Text - string
    • URL - string
  • For customer-provided data (e.g. data that is coming in via your CRM, Census, etc.), we will preserve the formatting of the original data signal so please ensure that you have the proper handling on your end when mapping the data.
  • If you choose to receive data as a CSV instead of a JSONL format, null values will be transmitted as empty strings.

Didn't find your answer?Get in touch· Visit ourhelp center