Features
Templates
Docs
Customers
Blog
Secondary navigation
Search...
⌘K
Log in
Sign up free
Docs
Docs menu
Intro
Welcome
The flow
Start building
Next steps & help
Key abstractions
Cohorts
Connections
Datasets
Deployments
Events
Forecasts
Outcomes
Persona sets
Pipelines
Recipes
Recommenders
Traits
How to
Use cases
Customers
Adaptive discounting
Churn scoring
Content personalization
Next best offer
Repeat purchase scoring
Leads
Adaptive discounting
Content personalization
First best offer
Lead scoring
Rep assignment
Predictions
Customer personas
Forecasted spend
Likelihood to buy again
Likelihood to churn
Likelihood to convert
Product recommendation
Rep assignment
Cohorts
Churned customers
Customers
Leads
One-time purchasers
Repeat purchasers
Event streams
Cancellation
Signup
Transaction
Connections
Aurora (MySQL)
AWS Aurora Postgres
Azure SQL
BigQuery
Facebook Custom Audiences
GCS
Google Ads
Google Cloud SQL (MySQL)
Google Cloud SQL (Postgres)
Google Cloud SQL (SQL Server)
HubSpot
Iterable
Klaviyo
LinkedIn Ads
MySQL
Pinterest Ads
Poplar
Postgres
RDS (MySQL)
RDS (Postgres)
RDS (SQL Server)
Recharge
Redshift
Redshift Serverless
S3
Salesforce
Salesforce Marketing Cloud
Segment
SFTP
Shopify
Snowflake
SQL Server
Stripe
The Trade Desk
TikTok
Features
Collaborating with others
Lookup API specification
Object preservation
Testing sandbox
Faraday Academy
Dashboard 101
Getting started
Describing your data
Deploying predictions
Making predictions
API reference
accounts
List accounts
get
Create account
post
Retrieve current account
get
Delete an account
delete
Retrieve an account
get
Update an account
patch
billing
Get billing information about the current account.
get
Get billing information about your account.
get
cohorts
List cohorts
get
Create cohort
post
Delete a cohort
delete
Retrieve a cohort
get
Edit a cohort
patch
Get the cohort membership counts over time.
get
Archive a cohort
post
Unarchive a cohort
post
connections
List connections
get
Create connection
post
Delete a connection
delete
Retrieve a connection
get
Update a connection
patch
Archive a connection
post
Retrieve all datasets that use this connection
get
Retrieve all targets that use this connection
get
Unarchive a connection
post
datasets
List datasets
get
Create dataset
post
Delete a dataset
delete
Retrieve a dataset
get
Update dataset
patch
Archive a dataset
post
Unarchive a dataset
post
graph
Retrieve a dependency graph for all resources on an account
get
outcomes
List outcomes
get
Create outcome
post
Delete an outcome
delete
Retrieve an outcome
get
Edit an outcome
patch
Retrieve an outcome's analysis
get
Archive a outcome
post
Retrieve outcome report
get
Unarchive a outcome
post
persona_sets
List persona sets
get
Create persona set
post
Delete a persona set
delete
Retrieve a persona set
get
Edit a persona set
patch
Get various trait breakdown information about a persona set.
get
Get various flow of persona sets over time.
get
Archive a persona set
post
Edit a persona
patch
Unarchive a persona set
post
places
List places
get
Create place
post
Delete a place
delete
Retrieve a place
get
Update place
patch
Archive a place
post
Unarchive a place
post
recommenders
List recommenders
get
Create recommender
post
Delete a recommender
delete
Retrieve a recommender
get
Edit a recommender
patch
Retrieve a recommenders's analysis
get
Archive a recommender
post
Unarchive a recommender
post
scopes
List scopes
get
Create scope
post
Delete a scope
delete
Retrieve a scope
get
Update a scope
patch
Archive a scope
post
Retrieve all datasets associated with a scope
get
Get payload cohorts for a scope
get
Get payload outcomes for a scope
get
Get payload persona sets for a scope
get
Get payload recommenders for a scope
get
Get population cohorts for a scope
get
Get population exclusion cohorts for a scope
get
Get targets for a scope
get
Unarchive a scope
post
streams
List streams
get
Delete a stream
delete
Retrieve a stream
get
Get the count of stream events emitted over a time period.
get
Archive a stream
post
Unarchive a stream
post
Create a stream
post
targets
List targets
get
Create target
post
Delete a target
delete
Retrieve a target
get
Update a target
patch
Archive a target
post
Download the default output of a target
get
Perform a lookup on the target, if its type is Lookup API.
post
Start a preview delivery
post
Unarchive a target
post
traits
Delete all orphaned traits
delete
List all user-defined and Faraday-provided traits
get
Create a Trait
post
List all user-defined and Faraday-provided traits, in csv form
get
Delete a trait
delete
Get a specific trait
get
Update a trait
patch
The percentage of the US population that falls into each category of this trait.
get
Archive a trait
post
Unarchive a trait
post
uploads
Retrieve the list of previously uploaded files
get
Delete a file
delete
Download a previously uploaded file
get
Add a file
post
usage
Get usage stats for your account.
get
webhooks
List webhook endpoints
get
Create webhook endpoint
post
Delete a webhook endpoint
delete
Retrieve a webhook
get
Update a webhook endpoint
patch
Docs
API reference