Enable a BigQuery Export for Your Dialer Organization


If your organization or campaign has a data team and a Google Cloud Platform BigQuery project, you can enable the Scale to Win Dialer to automatically sync your Dialer data to BigQuery.


Any Organization Owner for your dialer organization can set up this configuration. To do so, as shown below, they should 1) click on the circular, human-shaped icon in the top right corner of your dialer admin interface, 2) select the “Organization Settings” option from the menu, and then 3) click the “Data Exports” tab on the left side of the interface.


The “S3 Export” feature found in the “Data Exports” tab of the “Organization Settings” menu in your dialer admin interface.


The BigQuery sync runs every 15 minutes, syncing over new and updated data from the Dialer.


Important Notes Before Using the BigQuery Export


  • You’ll need to have a Google Cloud Platform account with a BigQuery project and a GCS Bucket.

  • You’ll create a new dataset inside your BigQuery project. The Scale to Win Dialer will automatically create all the right tables in the dataset for you, and keep them up to date if the schema changes.

  • The Scale to Win Dialer simply delivers this data to BigQuery. It’s up to you to build your own queries and dashboard on top of this data.


What Data Is Contained in the BigQuery Export


  • These exports contain most of the data from your Scale to Win Dialer’s database, other than some internal fields and tables.

  • Scale to Win omits some tables and fields that are still under active development to avoid having to introduce breaking schema changes for features that are still under development. 

    • Once a table or column is included, we’ll do our best to support that indefinitely. 

    • We’ll mark tables and columns as deprecated if they’re slated to be discontinued in the future, but will continue to provide the data in the current format for as long as possible.

  • New columns and tables may be added at any time.

  • Scale to Win won’t rename or delete columns. If we do have to discontinue a column, we’ll leave it in the table but with empty values to avoid breaking any queries that rely on it. You should also make sure that your queries can handle empty values in any column.


Steps to Prepare to Enable Your BigQuery Export


  1. Create a GCS bucket in your GCP account. You can also use an existing bucket. (The Scale to Win Dialer will allow you to specify a prefix for the files it stores in the bucket, so you can, for example, have multiple Scale to Win Dialer accounts using the same GCP bucket with different prefixes.) The Scale to Win Dialer will store temporary files in this bucket as part of the sync process, but you shouldn’t use these files directly – they’re just temporarily stored in the bucket as part of the sync.

  2. Create a BigQuery dataset. This dataset should be just for Scale to Win synced data, separate from all your other BigQuery data, since the Scale to Win dialer will need to create and update tables.

  3. Create a GCP Service Account. This service account will need the following permissions:

    • The “BigQuery job user” permission (on the service account itself)

    • The “Storage legacy bucket owner” and “Storage legacy object owner” permissions on the GCS bucket you created

    • The “BigQuery data owner” permission on the BigQuery dataset you created

  4. Create a JSON credential for this service account.

  5. Have your GCS bucket name, GCS object prefix (if you need one), dataset name, and JSON credential handy.


Steps to Enable Your BigQuery Export


  1. Have an Organization Owner navigate to the “Data Exports” tab within your dialer’s “Organization Settings” menu.

The “Data Exports” tab within your dialer organization’s “Organization Settings” menu.


  1. Click “Configure” in the “BigQuery Export” section.

The “Configure” button in the “BigQuery Export” section of the Data Exports page.


  1. Fill out the form and hit “Save.” Scale to Win will run a series of checks to make sure that you’ve set up the correct permissions.

The “Configure BigQuery Export” form to fill out and then hit “Save.”


  1. Wait for the next sync run. Your first sync should start running within 15 minutes. If you have a lot of data, this first sync may take a while (up to a few hours) to sync over all of your existing data. Future runs will be faster because they only sync over new and updated data.


The Scale to Win Dialer’s Data Dictionary


Now that you have BigQuery export enabled, you can learn more about the data schema from the Scale to Win Dialer’s Data Dictionary. 


You can find the Data Dictionary linked in the “BigQuery Export” section of the Data Exports tab of your dialer admin interface.


The link to the “Data Dictionary,” found in the “BigQuery Export” section of the “Data Exports” tab of your dialer admin interface.


A preview of the Scale to Win Dialer’s “Data Dictionary.”


Additionally, this documentation will be synced to your BigQuery table so you can view it in the BigQuery UI:

You can view the Scale to Win Dialer’s export documentation in your BigQuery UI.


You should ignore the tables ending with “__STAGING”. These are used by the sync process, but should not be queried directly.