Faraday REST APIv1.0.0

API base URL

Live server:https://api.faraday.ai/v1

Security

Bearer Authentication

Provide your API key in the Authorization header. You can find your API key in the Settings page of the dashboard.

Authorization: Bearer YOUR_TOKEN

Additional information

Contact support support@faraday.ai Terms of service

The Faraday API makes it easy to predict customer behavior programmatically. See our API change policy.

uploads

Uploading data to Faraday

Retrieve the list of previously uploaded files

/uploads/{directory}/{filename}

Download a previously uploaded file

/uploads/{directory}/{filename}

/uploads/{directory}/{filename}

datasets

Specifying how to import data

/datasets/{dataset_id}

Retrieve a dataset

/datasets/{dataset_id}

/datasets/{dataset_id}

Delete a dataset

/datasets/{dataset_id}/archive

Archive a dataset

/datasets/{dataset_id}/force_update

Trigger a rerun for this resource.

/datasets/{dataset_id}/logs/ingressexperimental

Get dataset ingress metrics over time

/datasets/{dataset_id}/logs/ingress/{log_id}experimental

Get a single dataset ingress log by ID

/datasets/{dataset_id}/unarchive

Unarchive a dataset

streams

Extracting data from datasets

/streams/{stream_id_or_name}

Retrieve a stream

/streams/{stream_id_or_name}

Update a stream

/streams/{stream_id_or_name}

Delete a stream

/streams/{stream_id_or_name}/analysis

Get the count of stream events emitted over a time period.

/streams/{stream_id_or_name}/archive

Archive a stream

/streams/{stream_id_or_name}/force_update

Trigger a rerun for this resource.

/streams/{stream_id_or_name}/unarchive

Unarchive a stream

/streams/{stream_name}

Create a stream

cohorts

Declaring cohorts (populations of customers, etc.)

/cohorts/{cohort_id}

Retrieve a cohort

/cohorts/{cohort_id}

/cohorts/{cohort_id}

Delete a cohort

/cohorts/{cohort_id}/analysis/membership

Get the cohort membership counts over time.

/cohorts/{cohort_id}/archive

Archive a cohort

/cohorts/{cohort_id}/force_update

Trigger a rerun for this resource.

/cohorts/{cohort_id}/unarchive

Unarchive a cohort

outcomes

Declare business outcomes (propensity to buy, etc)

/outcomes/{outcome_id}

Retrieve an outcome

/outcomes/{outcome_id}

Edit an outcome

/outcomes/{outcome_id}

Delete an outcome

/outcomes/{outcome_id}/analysis

Retrieve an outcome's analysis

/outcomes/{outcome_id}/archive

Archive a outcome

/outcomes/{outcome_id}/force_update

Trigger a rerun for this resource.

/outcomes/{outcome_id}/report.html

Retrieve outcome report

/outcomes/{outcome_id}/unarchive

Unarchive a outcome

persona_sets

Segment cohorts into personas

/persona_sets

List persona sets

/persona_sets

Create persona set

/persona_sets/{persona_set_id}

Retrieve a persona set

/persona_sets/{persona_set_id}

Edit a persona set

/persona_sets/{persona_set_id}

Delete a persona set

/persona_sets/{persona_set_id}/analysis/dimensions

Get various trait breakdown information about a persona set.

/persona_sets/{persona_set_id}/analysis/flow

Get various flow of persona sets over time.

/persona_sets/{persona_set_id}/archive

Archive a persona set

/persona_sets/{persona_set_id}/force_update

Trigger a rerun for this resource.

/persona_sets/{persona_set_id}/personas/{persona_id}

/persona_sets/{persona_set_id}/unarchive

Unarchive a persona set

scopes

Get predictions about individuals

/scopes/{scope_id}

Retrieve a scope

/scopes/{scope_id}

/scopes/{scope_id}

/scopes/{scope_id}/analysis

Get analysis for a scope

/scopes/{scope_id}/analysis/geography

Get geographic breakdown for a scope

/scopes/{scope_id}/archive

Archive a scope

/scopes/{scope_id}/datasets

Retrieve all datasets associated with a scope

/scopes/{scope_id}/efficacy

Get efficacy for a scope

/scopes/{scope_id}/force_update

Trigger a rerun for this resource.

/scopes/{scope_id}/payload/cohorts

Get payload cohorts for a scope

/scopes/{scope_id}/payload/outcomes

Get payload outcomes for a scope

/scopes/{scope_id}/payload/persona_sets

Get payload persona sets for a scope

/scopes/{scope_id}/payload/recommenders

Get payload recommenders for a scope

/scopes/{scope_id}/population/cohorts

Get population cohorts for a scope

/scopes/{scope_id}/population/exclusion_address_level_cohorts

Get address-level population exclusion cohorts for a scope

/scopes/{scope_id}/population/exclusion_cohorts

Get population exclusion cohorts for a scope

/scopes/{scope_id}/targets

Get targets for a scope

/scopes/{scope_id}/unarchive

Unarchive a scope

attributes

Managing attributes that wrap assertion streams

List attributes

Create attribute

/attributes/{attribute_id}

Retrieve an attribute

/attributes/{attribute_id}

Update an attribute

/attributes/{attribute_id}

Delete an attribute

/attributes/{attribute_id}/force_update

Trigger a rerun for this resource.

feature_stores

Managing feature store collections

/feature_stores

List feature stores

/feature_stores

Create feature store

/feature_stores/{feature_store_id}

Retrieve a feature store

/feature_stores/{feature_store_id}

Update a feature store

/feature_stores/{feature_store_id}

Delete a feature store

/feature_stores/{feature_store_id}/force_update

Trigger a rerun for this resource.

connections

Configuration of external environments for data import and export

List connections

Create connection

/connections/{connection_id}

Retrieve a connection

/connections/{connection_id}

Update a connection

/connections/{connection_id}

Delete a connection

/connections/{connection_id}/archive

Archive a connection

/connections/{connection_id}/datasets

Retrieve all datasets that use this connection

/connections/{connection_id}/force_update

Trigger a rerun for this resource.

/connections/{connection_id}/rotate_credentials

Rotate credentials for a connection

/connections/{connection_id}/targets

Retrieve all targets that use this connection

/connections/{connection_id}/unarchive

Unarchive a connection

targets

Configuration for exporting data from Faraday, possibly to an external environment (with connections)

/targets/{target_id}

Retrieve a target

/targets/{target_id}

Update a target

/targets/{target_id}

Delete a target

/targets/{target_id}/analysis

Retrieve a target's analysis

/targets/{target_id}/analysis/pdf

Retrieve target analysis report

/targets/{target_id}/archive

Archive a target

/targets/{target_id}/download.csv

Download the default output of a target

/targets/{target_id}/force_update

Trigger a rerun for this resource.

/targets/{target_id}/lookup

Perform a lookup on the target, if its type is Lookup API.

/targets/{target_id}/preview

Start a preview delivery

/targets/{target_id}/unarchive

Unarchive a target

accounts

Account configuration

/accounts/current

Retrieve current account

/accounts/current/usageexperimental

Get usage metrics for current account

/accounts/current/usage/allexperimental

Get usage metrics for current and sub accounts

/accounts/{account_id}

Retrieve an account

/accounts/{account_id}

Update an account

/accounts/{account_id}

Delete an account

/accounts/{account_id}/usageexperimental

Get usage metrics for a specific account

knowledgebase

Per-account overview, use cases, and revision history (the account knowledgebase)

/knowledgebase/overview

Retrieve the account overview

/knowledgebase/overview

Update the account overview

/knowledgebase/overview/revisions

List account overview revisions

/knowledgebase/overview/revisions/{revision_id}

Retrieve a specific account overview revision

/knowledgebase/use_cases

/knowledgebase/use_cases

Create a use case

/knowledgebase/use_cases/{use_case_id}

Retrieve a use case

/knowledgebase/use_cases/{use_case_id}

Update a use case

/knowledgebase/use_cases/{use_case_id}/archive

Archive a use case

/knowledgebase/use_cases/{use_case_id}/revisions

List use case revisions

/knowledgebase/use_cases/{use_case_id}/revisions/{revision_id}

Retrieve a specific use case revision

/knowledgebase/use_cases/{use_case_id}/unarchive

Unarchive a use case

graph

Get dependency graph for the account's resources

Retrieve a dependency graph for all resources on an account

billing

/accounts/current/billing

Get billing information about the current account.

/accounts/{account_id}/billing

Get billing information about your account.

market_opportunity_analyses

/market_opportunity_analyses

Get all market opportunity analyses

/market_opportunity_analyses

Create a new market opportunity analysis

/market_opportunity_analyses/{market_opportunity_analysis_id}

Get a specific market opportunity analysis

/market_opportunity_analyses/{market_opportunity_analysis_id}

Update a specific market opportunity analysis

/market_opportunity_analyses/{market_opportunity_analysis_id}

Delete a specific market opportunity analysis

/market_opportunity_analyses/{market_opportunity_analysis_id}/archive

Archive a specific market opportunity analysis

/market_opportunity_analyses/{market_opportunity_analysis_id}/force_update

Trigger a rerun for this resource.

/market_opportunity_analyses/{market_opportunity_analysis_id}/unarchive

Unarchive a specific market opportunity analysis

places

/places/{place_id}

Retrieve a place

/places/{place_id}

/places/{place_id}

/places/{place_id}/archive

Archive a place

/places/{place_id}/force_update

Trigger a rerun for this resource.

/places/{place_id}/unarchive

Unarchive a place

recommenders

/recommenders

List recommenders

/recommenders

Create recommender

/recommenders/{recommender_id}

Retrieve a recommender

/recommenders/{recommender_id}

Edit a recommender

/recommenders/{recommender_id}

Delete a recommender

/recommenders/{recommender_id}/analysis

Retrieve a recommenders's analysis

/recommenders/{recommender_id}/archive

Archive a recommender

/recommenders/{recommender_id}/force_update

Trigger a rerun for this resource.

/recommenders/{recommender_id}/unarchive

Unarchive a recommender

traits

List all user-defined and Faraday-provided traits

Delete all orphaned traits

List all user-defined and Faraday-provided traits, in csv form

/traits/{trait_id}

Get a specific trait

/traits/{trait_id}

/traits/{trait_id}

/traits/{trait_id}/analysis/dimensions

The percentage of the US population that falls into each category of this trait.

/traits/{trait_id}/archive

Archive a trait

/traits/{trait_id}/force_update

Trigger a rerun for this resource.

/traits/{trait_id}/unarchive

Unarchive a trait

usage

Get usage stats for your account.

webhooks

/webhook_endpoints

List webhook endpoints

/webhook_endpoints

Create webhook endpoint

/webhook_endpoints/{webhook_endpoint_id}

Retrieve a webhook

/webhook_endpoints/{webhook_endpoint_id}

Update a webhook endpoint

/webhook_endpoints/{webhook_endpoint_id}

Delete a webhook endpoint

Webhook events

Webhook events are sent to your configured endpoints when specific events occur in your Faraday account. Each event sends a POST request with the relevant payload.

resource.errored

Resource Errored

resource.ready_with_update

Resource Ready With Update