Testing sandbox

Use Faraday's Farazona dummy data to test the process of building predictions in Faraday.

Faraday requires customer data in order to make predictions. If you're just starting out, you might want to try things out before sending us real data.

That's why we've created a sample file you can use to experience every aspect of the Faraday API. The PII is artificial, but there is real signal in this data.

Account & credentials

Create a free account if you haven't already. You will immediately get an API key that works for testing.

Sample data

Faraday normally operates on the nationwide US adult population. When your account is in test mode, however, it's pointed at the fictional state of Farazona, with a population of around 1 million adults. Residents of Farazona are artificial people whose data closely resembles real-world patterns we find in actual US adults. This ensures that models you build with sample data will exhibit similar performance you will find when operating on real data.

Download

Faraday has selected 500,000 residents of Farazona to serve as customers for the fictitious company Acme. We have sample orders and churn data available for download.

We suggest you follow up by trying one of our quickstarts - Personalizing your outreach or Score leads as they come in.

Orders data

You can download sample order data here:

📂 Sample order data

curl -sSLO https://storage.googleapis.com/farazona/acme_orders.csv

You can upload this to your account like this:

curl --request POST \
     --url https://api.faraday.ai/v1/uploads/orders/file1.csv \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer YOUR_API_KEY' \
     --header 'Content-Type: application/octet-stream' \
     --data-binary "@acme_orders.csv"

Then you can describe it to us like this:

curl --request POST \
     --url https://api.faraday.ai/v1/datasets \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer YOUR_API_KEY' \
     --header 'Content-Type: application/json' \
     --data '
{
    "name": "orders_data",
     "identity_sets": {
          "customer": {
               "house_number_and_street": [
                    "address"
               ],
               "person_first_name": "first_name",
               "person_last_name": "last_name",
               "city": "city",
               "state": "state"
          }
     },
     "output_to_streams": {
          "orders": {
               "data_map": {
                    "datetime": {
                         "column_name": "date",
                         "format": "date_iso8601"
                    },
                    "value": {
                         "column_name": "total",
                         "format": "currency_dollars"
                    }
               }
          }
    },
    "options": {
        "type": "hosted_csv",
        "upload_directory": "orders"
    }
}
'

Leads data

You can download sample lead data here:

📂 Sample lead data

curl -sSLO https://storage.googleapis.com/farazona/acme_leads.csv

You can upload this to your account like this:

curl --request POST \
     --url https://api.faraday.ai/v1/uploads/leads/file1.csv \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer YOUR_API_KEY' \
     --header 'Content-Type: application/octet-stream' \
     --data-binary "@acme_leads.csv"

Then you can describe it to us like this:

curl --request POST \
     --url https://api.faraday.io/v1/datasets \
     --header 'Accept: application/json' \
     --header "Authorization: Bearer YOUR_API_KEY" \
     --header "Content-Type: application/json" \
     --data '
{
     "name": "leads_data",
     "identity_sets": {
          "lead": {
               "city": "city",
               "person_first_name": "first_name",
               "person_last_name": "last_name",
               "state": "state",
               "house_number_and_street": [
                    "address"
               ]
          }
     },
     "options": {
          "type": "hosted_csv",
          "upload_directory": "leads"
     },
     "output_to_streams": {
          "leads": {
               "data_map": {
                    "datetime": {
                         "column_name": "date",
                         "format": "date_iso8601"
                    }
               }
          }
     }

}
'

Churn data

You can download sample churn data here:

📂 Sample churn data

curl -sSLO https://storage.googleapis.com/farazona/acme_churns.csv

You can upload this to your account like this:

curl  --request POST \
      --url https://api.faraday.ai/v1/uploads/churns/churns1.csv \
      --header 'Accept: application/json' \
      --header "Authorization: Bearer YOUR_API_KEY" \
      --header "Content-Type: application/octet-stream" \
      --data-binary "@acme_churns.csv"

You can describe it to us like this:

curl --request POST \
     --url https://api.faraday.ai/v1/datasets \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer YOUR_API_KEY' \
     --header 'Content-Type: application/json' \
     --data '
{
    "name": "churns_data",
     "identity_sets": {
          "customer": {
               "house_number_and_street": [
                    "address"
               ],
               "person_first_name": "first_name",
               "person_last_name": "last_name",
               "city": "city",
               "state": "state"
          }
     },
     "output_to_streams": {
          "churns": {
               "data_map": {
                    "datetime": {
                         "column_name": "churn_date",
                         "format": "date_iso8601"
                    }
               }
          }
    },
    "options": {
        "type": "hosted_csv",
        "upload_directory": "churns"
    }
}
'