Exporting Scores

🚧

Preview feature

Exporting scores is a newly available preview feature. We're excited for you to use it, but is still under development. It may not be feature complete, and we don't offer our normal SLAs for this feature.

Correlated's exporting feature allows you to periodically receive granular data from the scoring engine in a form that you can use in your own applications and third party services. Scores from any of your models can be exported to commonly used cloud object storage services, like Amazon S3 or Google Cloud GCS. To use the exporting feature, please contact [email protected], or get in touch with Correlated's customer success team. Follow this guide to learn how to set up and configure scoring exports.

Overview

• Correlated currently supports exporting to Amazon S3 or Google Cloud GCS.
• Scores are uploaded once per day
• Scores can be uploaded in CSV or JSON
• One file will be created per scoring model that you've configured
• Each file contains one row per scored user or account
• Each file contains the following property per user/account:
  • The global identifier for the user/account
  • The date and time at which the score was most recently determined
  • The numeric score value, between 0 and 100
  • Whether the user/account has converted since receiving the score, true or false

Setting up GCS for scoring exports

1. Create a destination bucket in GCS where you'd like scores to be exported to.
   1. Follow these steps in the GCP docs to learn how to use the GCP console to create a bucket
   2. Using the gcloud command line tool, run the following command: gcloud storage buckets create gs://your-bucket-name/ --uniform-bucket-level-access
2. Grant Correlated the appropriate access permissions for the bucket you just created
   1. To do this in the GCP console:
      1. Visit the GCS buckets console in GCP
      2. Click on the name of the bucket you created in step 1
      3. Click on the 'Permissions' tab
      4. Click on the 'Grant Access' button
      5. In the sidebar, enter [email protected] in the 'Add principals' text box
      6. Add the following roles in the 'Assign roles' section of the form:
         1. Storage Object Viewer
         2. Storage Object Creator
      7. Click Save
   2. To do this using the gcloud command line tool:
      1. Run the following commands:

         gcloud storage buckets add-iam-policy-binding gs://your-bucket-name --member=user:[email protected] --role=roles/storage.objectCreator
         gcloud storage buckets add-iam-policy-binding gs://your-bucket-name --member=user:[email protected] --role=roles/storage.objectViewer
      

Setting Up S3 for Scoring Exports

Coming soon!