Faraday

Delete an account via DELETE /accounts/{account_id}. Request an account deletion. In 24 hours, the account and all resources associated with it will be deleted. Contact support within the 24 hour window if you wish to reverse this.

Delete an atlas via DELETE /atlases/{atlas_id}.

Delete an attribute via DELETE /attributes/{attribute_id}.

Delete a cohort via DELETE /cohorts/{cohort_id}.

Delete a connection via DELETE /connections/{connection_id}.

Delete a dataset via DELETE /datasets/{dataset_id}.

Delete a feature store via DELETE /feature_stores/{feature_store_id}.

Delete a use case via DELETE /knowledgebase/use_cases/{use_case_id}. Delete a use case. Unlike archiving, a deleted use case is no longer returned by any read, including when listing archived use cases.

Delete a specific market opportunity analysis via DELETE /market_opportunity_analyses/{market_opportunity_analysis_id}.

Delete a migration via DELETE /migrations/{migration_id}.

Delete an outcome via DELETE /outcomes/{outcome_id}.

Delete a persona set via DELETE /persona_sets/{persona_set_id}.

DEPRECATED by Faraday: this operation is marked deprecated in Faraday's own API reference. It still answers, so it remains available for accounts that already hold this data, but prefer the successor named below for new work. Delete a place via DELETE /places/{place_id}. Delete a place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See DELETE /atlases/{atlas_id}.

Delete a recommender via DELETE /recommenders/{recommender_id}.

Delete a scope via DELETE /scopes/{scope_id}.

Delete a stream via DELETE /streams/{stream_id_or_name}.

Delete a target via DELETE /targets/{target_id}.

Delete all orphaned traits via DELETE /traits. Delete all traits without a source dataset.

Delete a trait via DELETE /traits/{trait_id}.

Delete a file via DELETE /uploads/{directory}/{filename}. Delete a CSV file previously uploaded.

Delete a webhook endpoint via DELETE /webhook_endpoints/{webhook_endpoint_id}.

List accounts via GET /accounts. Get a list of accounts defined on the account. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Retrieve an account via GET /accounts/{account_id}. Get details on a specific account. This must be an account controlled by your API key. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard.

Get billing information about your account via GET /accounts/{account_id}/billing. Get invoices, payments, and usage stats for your account.

Get usage metrics for a specific account via GET /accounts/{account_id}/usage.

Retrieve current account via GET /accounts/current. Get details on the current account, as identified by the API key. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard.

Get billing information about the current account via GET /accounts/current/billing. Get invoices, payments, and usage stats for the current account.

Get usage metrics for current account via GET /accounts/current/usage. Get historical usage metrics for the current account from the most recent metrics dashboard event.

Get usage metrics for current and sub accounts via GET /accounts/current/usage/all. Get aggregated historical usage metrics for the current account and all of its sub-accounts.

List atlases via GET /atlases. Get a list of the atlases defined on the account. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Retrieve an atlas via GET /atlases/{atlas_id}. Retrieve details on a specific atlas.

List the locations of an atlas via GET /atlases/{atlas_id}/locations. Get a list of the locations belonging to a specific atlas. Paged with limit and offset, not a cursor. There is no next link in the response, so page by advancing offset by limit until a short page comes back.

List attributes via GET /attributes. Get a list of attributes defined on the account. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Retrieve an attribute via GET /attributes/{attribute_id}. Get details on a specific attribute.

List cohorts via GET /cohorts. Get a list of cohorts defined on the account. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Retrieve a cohort via GET /cohorts/{cohort_id}. Get details on a specific cohort.

Get the cohort membership counts over time via GET /cohorts/{cohort_id}/analysis/membership.

List connections via GET /connections. Get a list of connections defined on the account. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Retrieve a connection via GET /connections/{connection_id}. Get details on a specific connection. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard.

Retrieve all datasets that use this connection via GET /connections/{connection_id}/datasets. Get all datasets that use this connection.

Retrieve all targets that use this connection via GET /connections/{connection_id}/targets. Get all targets that use this connection. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard.

List datasets via GET /datasets. Get a list of the datasets defined on the account. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Retrieve a dataset via GET /datasets/{dataset_id}. Retrieve details on a specific dataset.

Get dataset ingress metrics over time via GET /datasets/{dataset_id}/logs/ingress. Retrieves ingress metrics for a specific dataset. Paged with limit and offset, not a cursor. There is no next link in the response, so page by advancing offset by limit until a short page comes back.

Get a single dataset ingress log by ID via GET /datasets/{dataset_id}/logs/ingress/{log_id}. Retrieves a specific ingress log entry for a dataset.

List feature stores via GET /feature_stores. Get a list of feature stores defined on the account. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Retrieve a feature store via GET /feature_stores/{feature_store_id}. Get details on a specific feature store.

Retrieve a dependency graph for all resources on an account via GET /graph. Each object in the list is an edge in the dependency graph.

Retrieve the account overview via GET /knowledgebase/overview. Get the current revision of this account's knowledgebase overview. If no overview has ever been written, `revision_id` and `created_at` are absent and `content` is the empty string.

List account overview revisions via GET /knowledgebase/overview/revisions. List every saved revision of the account overview, newest first.

Retrieve a specific account overview revision via GET /knowledgebase/overview/revisions/{revision_id}. Read an older saved revision of the account overview. The shape matches the current-revision endpoint.

List use cases via GET /knowledgebase/use_cases. Get a list of use cases for the calling account. Returns summary fields only; fetch a specific use case to see its preface, guide, and resources. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Retrieve a use case via GET /knowledgebase/use_cases/{use_case_id}. Get the full current revision of a use case, including its computed `resources` list.

List use case revisions via GET /knowledgebase/use_cases/{use_case_id}/revisions. List every saved revision of a use case, newest first.

Retrieve a specific use case revision via GET /knowledgebase/use_cases/{use_case_id}/revisions/{revision_id}. Read an older saved revision of a use case. The shape matches the current-revision endpoint, except `resources` is omitted (resources are a live computed property, not part of the versioned content).

List locations via GET /locations. Get a list of the locations belonging to every atlas on the account. Paged with limit and offset, not a cursor. There is no next link in the response, so page by advancing offset by limit until a short page comes back.

Get all market opportunity analyses via GET /market_opportunity_analyses. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Get a specific market opportunity analysis via GET /market_opportunity_analyses/{market_opportunity_analysis_id}.

List migrations via GET /migrations. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Retrieve a migration via GET /migrations/{migration_id}.

List outcomes via GET /outcomes. Get a list of outcomes defined on the account. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Retrieve an outcome via GET /outcomes/{outcome_id}. Get details on a specific outcome.

Retrieve an outcome's analysis via GET /outcomes/{outcome_id}/analysis. Get details on a specific outcome's analysis report on model performance, bias, etc.

Retrieve outcome report via GET /outcomes/{outcome_id}/report.html. Download an HTML report containing information such as the objective of the model, performance, and important features.

List persona sets via GET /persona_sets. A list of available persona sets. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Retrieve a persona set via GET /persona_sets/{persona_set_id}. Details on a specific persona set, including details on all of its constituent personas.

Get various trait breakdown information about a persona set via GET /persona_sets/{persona_set_id}/analysis/dimensions.

DEPRECATED by Faraday: this operation is marked deprecated in Faraday's own API reference. It still answers, so it remains available for accounts that already hold this data, but prefer the successor named below for new work. Get various flow of persona sets over time via GET /persona_sets/{persona_set_id}/analysis/flow.

DEPRECATED by Faraday: this operation is marked deprecated in Faraday's own API reference. It still answers, so it remains available for accounts that already hold this data, but prefer the successor named below for new work. List places via GET /places. Get a list of the places defined on the account. Geometry and addresses are omitted from this endpoint's response to avoid overly large response sizes. If you want to inspect a place's geometry or addresses, then use GET /places/<place id>. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See GET /atlases. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

DEPRECATED by Faraday: this operation is marked deprecated in Faraday's own API reference. It still answers, so it remains available for accounts that already hold this data, but prefer the successor named below for new work. Retrieve a place via GET /places/{place_id}. Retrieve details on a specific place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See GET /atlases/{atlas_id}.

List recommenders via GET /recommenders. Get a list of recommenders defined on the account. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Retrieve a recommender via GET /recommenders/{recommender_id}. Get details on a specific recommender.

Retrieve a recommenders's analysis via GET /recommenders/{recommender_id}/analysis. Get details on a specific recommender's analysis report on model performance, bias, etc.

List scopes via GET /scopes. Get a list of scopes defined on the account. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Retrieve a scope via GET /scopes/{scope_id}. Get details on a specific scope.

Get analysis for a scope via GET /scopes/{scope_id}/analysis.

Get geographic breakdown for a scope via GET /scopes/{scope_id}/analysis/geography. Get a postcode- and state-level breakdown of the scope population, including per-payload-cohort counts. `postcodes` may be omitted when the scope spans more than 250 distinct postcodes (the UI distribution table saturates at that point); `states` is always present.

Retrieve all datasets associated with a scope via GET /scopes/{scope_id}/datasets. Retrieve all datasets associated with a scope. For example, if your scope has population_cohorts, you built those cohorts using data from one of your datasets. This endpoint gets all such datasets. This can be used with referenced targets, to figure out which source tables the target can reference.

Get efficacy for a scope via GET /scopes/{scope_id}/efficacy.

Get payload cohorts for a scope via GET /scopes/{scope_id}/payload/cohorts.

Get payload outcomes for a scope via GET /scopes/{scope_id}/payload/outcomes.

Get payload persona sets for a scope via GET /scopes/{scope_id}/payload/persona_sets.

Get payload recommenders for a scope via GET /scopes/{scope_id}/payload/recommenders.

Get population cohorts for a scope via GET /scopes/{scope_id}/population/cohorts.

Get address-level population exclusion cohorts for a scope via GET /scopes/{scope_id}/population/exclusion_address_level_cohorts.

Get population exclusion cohorts for a scope via GET /scopes/{scope_id}/population/exclusion_cohorts.

Get targets for a scope via GET /scopes/{scope_id}/targets. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard.

List streams via GET /streams. List all streams present on the account. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Retrieve a stream via GET /streams/{stream_id_or_name}. Look up a specific event stream.

Get the count of stream events emitted over a time period via GET /streams/{stream_id_or_name}/analysis.

List targets via GET /targets. Get a list of targets defined on the account. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Retrieve a target via GET /targets/{target_id}. Get details on a specific target. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard.

Retrieve a target's analysis via GET /targets/{target_id}/analysis. Get details on a target's analysis report for specific trait, attribute, and/or geography dimensions.

Retrieve target analysis report via GET /targets/{target_id}/analysis/pdf. Gets a redirect URL to download a PDF report.

Download the default output of a target via GET /targets/{target_id}/download.csv.

List all user-defined and Faraday-provided traits via GET /traits. Get a list of all available traits, including those provided by Faraday and those defined by the user. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Get a specific trait via GET /traits/{trait_id}. Get a specific trait by ID.

The percentage of the US population that falls into each category of this trait via GET /traits/{trait_id}/analysis/dimensions.

List all user-defined and Faraday-provided traits, in csv form via GET /traits.csv. Get a csv of all available traits, including those provided by Faraday and those defined by the user.

Retrieve the list of previously uploaded files via GET /uploads. A list of files uploaded via /uploads/{directory}/{filename}, and their metadata.

Download a previously uploaded file via GET /uploads/{directory}/{filename}. The file uploaded via /uploads/{directory}/{filename}.

Get usage stats for your account via GET /usages.

List webhook endpoints via GET /webhook_endpoints. Get a list of webhook endpoints defined on the account. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard. The ids filter is repeated, not comma-separated: ?ids=<a>&ids=<b>, at most 100 per call.

Retrieve a webhook via GET /webhook_endpoints/{webhook_endpoint_id}. Get details on a specific webhook endpoint. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard.

Update an account via PATCH /accounts/{account_id}. Update the configuration of an account. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard.

Update atlas via PATCH /atlases/{atlas_id}. Update an existing atlas. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets.

Update an attribute via PATCH /attributes/{attribute_id}. Update the configuration of an attribute. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets.

Edit a cohort via PATCH /cohorts/{cohort_id}. Edit configuration of a cohort. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets.

Update a connection via PATCH /connections/{connection_id}. Update the configuration of a connection. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard.

Update dataset via PATCH /datasets/{dataset_id}. Update an existing dataset. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets.

Update a feature store via PATCH /feature_stores/{feature_store_id}. Update the configuration of a feature store. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets.

Update the account overview via PATCH /knowledgebase/overview. Save a new revision of the account overview. Optimistic locking: pass back the `revision_id` you read; if the server's current revision has moved past it, the request is rejected with 409. Omit `revision_id` only when the overview has never been written before.

Update a use case via PATCH /knowledgebase/use_cases/{use_case_id}. Save a new revision of a use case. Optimistic locking: pass back the `revision_id` you read; if the server's current revision has moved past it, the request is rejected with 409. Fields not present are left at their current values. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets.

Update a specific market opportunity analysis via PATCH /market_opportunity_analyses/{market_opportunity_analysis_id}.

Update a migration via PATCH /migrations/{migration_id}. Update a migration with a JSON Merge Patch. Configuration fields (`notes`, `datasets`, `targets`, `cohorts`, `outcomes`, `persona_sets`, `recommenders`) may be changed only by the owning FIG v2 account while the migration is unapproved. Either linked account may provide a non-null `approved_at` to queue the account move. The server records the approval time; repeated approval requests succeed without changing the first approval. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets.

Edit an outcome via PATCH /outcomes/{outcome_id}. Edit configuration of an existing outcome. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets.

Edit a persona set via PATCH /persona_sets/{persona_set_id}. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets.

Edit a persona via PATCH /persona_sets/{persona_set_id}/personas/{persona_id}. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets.

DEPRECATED by Faraday: this operation is marked deprecated in Faraday's own API reference. It still answers, so it remains available for accounts that already hold this data, but prefer the successor named below for new work. Update place via PATCH /places/{place_id}. Update an existing place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See PATCH /atlases/{atlas_id}. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets.

Edit a recommender via PATCH /recommenders/{recommender_id}. Edit configuration of a recommender. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets.

Update a scope via PATCH /scopes/{scope_id}. Update the configuration of a scope. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets.

Update a stream via PATCH /streams/{stream_id_or_name}. Update the configuration of a stream. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets.

Update a target via PATCH /targets/{target_id}. Update the configuration of a target. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard.

Update a trait via PATCH /traits/{trait_id}. Update the configuration of a trait. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets.

Update a webhook endpoint via PATCH /webhook_endpoints/{webhook_endpoint_id}. Update the configuration of a webhook endpoint. This is an RFC 7396 MERGE PATCH: send only the fields you are changing, and send an explicit null to CLEAR a field. Omitting a field leaves it alone; sending null erases it. The request goes out with Content-Type application/merge-patch+json, which this integration sets. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard.

Create account via POST /accounts. Create a subaccount. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard.

Create atlas via POST /atlases. Create a new atlas.

Archive an atlas via POST /atlases/{atlas_id}/archive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Trigger a rerun for this resource via POST /atlases/{atlas_id}/force_update. Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

Unarchive an atlas via POST /atlases/{atlas_id}/unarchive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Create attribute via POST /attributes. Add a new attribute that wraps a stream of assertions.

Trigger a rerun for this resource via POST /attributes/{attribute_id}/force_update. Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

Create cohort via POST /cohorts. Add a new cohort (defined as people who have made qualifying emissions of certain events).

Archive a cohort via POST /cohorts/{cohort_id}/archive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Trigger a rerun for this resource via POST /cohorts/{cohort_id}/force_update. Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

Unarchive a cohort via POST /cohorts/{cohort_id}/unarchive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Create connection via POST /connections. Add a new connection. Connections are configuration for connecting data between Faraday and an external location. They are required when working with <a href="https://faraday.ai/developers/reference/createtarget">**replication targets**</a>. All connections have a `type` that determines which options may be specified. Connection `type` is specified in the `options` object. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard.

Archive a connection via POST /connections/{connection_id}/archive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Trigger a rerun for this resource via POST /connections/{connection_id}/force_update. Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

Rotate credentials for a connection via POST /connections/{connection_id}/rotate_credentials. Rotate credentials for a Snowflake or ClickHouse connection. This regenerates the connection type's keypair. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard.

Unarchive a connection via POST /connections/{connection_id}/unarchive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Create dataset via POST /datasets. Create a new dataset.

Archive a dataset via POST /datasets/{dataset_id}/archive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Trigger a rerun for this resource via POST /datasets/{dataset_id}/force_update. Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

Unarchive a dataset via POST /datasets/{dataset_id}/unarchive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Create feature store via POST /feature_stores. Add a new feature store that compiles attributes.

Trigger a rerun for this resource via POST /feature_stores/{feature_store_id}/force_update. Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

Real-time checklist for a use-case draft via POST /knowledgebase/use_case_checklist. A fast, text-only completeness check for a use case still being written: given the draft `title`, `preface`, and `technical_details`, it returns the use case's `flavor` and a per-flavor checklist of requirements, each marked covered / partial / missing. Intended to be called (debounced) as the author types. Ephemeral — nothing is persisted, and it does not gate anything (the review does). Runs on a fast model, so it is guidance rather than an authoritative verdict.

Create a use case via POST /knowledgebase/use_cases. Create a new use case under the calling account.

Archive a use case via POST /knowledgebase/use_cases/{use_case_id}/archive. Archive a use case. Use cases have no downstream dependents so no cascade configuration is required. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Generate an implementation guide for a use case via POST /knowledgebase/use_cases/{use_case_id}/generate_guide. Request generation of an implementation guide for a use case, from its `preface` and `technical_details`. Enqueues the generation and returns it immediately with `status: "pending"`; it is filled in asynchronously. A guide is only produced once the use case's latest review judged it adequate, and never for a use case marked `draft`. Poll the use case (its computed `guide_generation` field) to see the result; when `status` is `"ready"`, the guide's Markdown is on `generated_guide`.

Request a review of a use case via POST /knowledgebase/use_cases/{use_case_id}/review. Request an agentic review of a use case: does it carry enough — its preface plus technical details — to generate a correct implementation guide and to audit the account against it? Enqueues the review and returns it immediately with `status: "pending"`; it is filled in asynchronously. Poll the use case (its computed `review` field) or read this response's `id` to see the result once `status` is `"ready"`.

Unarchive a use case via POST /knowledgebase/use_cases/{use_case_id}/unarchive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Create a new market opportunity analysis via POST /market_opportunity_analyses.

Archive a specific market opportunity analysis via POST /market_opportunity_analyses/{market_opportunity_analysis_id}/archive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Trigger a rerun for this resource via POST /market_opportunity_analyses/{market_opportunity_analysis_id}/force_update.

Unarchive a specific market opportunity analysis via POST /market_opportunity_analyses/{market_opportunity_analysis_id}/unarchive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Create a migration via POST /migrations.

Trigger a rerun for this resource via POST /migrations/{migration_id}/force_update. Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

Create outcome via POST /outcomes. Add a new outcome (defined as a prediction of how likely individuals are to transition from one cohort to another).

Archive a outcome via POST /outcomes/{outcome_id}/archive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Trigger a rerun for this resource via POST /outcomes/{outcome_id}/force_update. Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

Unarchive a outcome via POST /outcomes/{outcome_id}/unarchive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Create persona set via POST /persona_sets. Invoke the build of a new persona set for a given cohort.

Archive a persona set via POST /persona_sets/{persona_set_id}/archive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Trigger a rerun for this resource via POST /persona_sets/{persona_set_id}/force_update. Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

Unarchive a persona set via POST /persona_sets/{persona_set_id}/unarchive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

DEPRECATED by Faraday: this operation is marked deprecated in Faraday's own API reference. It still answers, so it remains available for accounts that already hold this data, but prefer the successor named below for new work. Create place via POST /places. Create a new place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. Build new spatial filters on an atlas: see POST /atlases.

DEPRECATED by Faraday: this operation is marked deprecated in Faraday's own API reference. It still answers, so it remains available for accounts that already hold this data, but prefer the successor named below for new work. Archive a place via POST /places/{place_id}/archive. Archive a place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See POST /atlases/{atlas_id}/archive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

DEPRECATED by Faraday: this operation is marked deprecated in Faraday's own API reference. It still answers, so it remains available for accounts that already hold this data, but prefer the successor named below for new work. Trigger a rerun for this resource via POST /places/{place_id}/force_update. Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See POST /atlases/{atlas_id}/force_update.

DEPRECATED by Faraday: this operation is marked deprecated in Faraday's own API reference. It still answers, so it remains available for accounts that already hold this data, but prefer the successor named below for new work. Unarchive a place via POST /places/{place_id}/unarchive. Unarchive a place. Places are superseded by atlases, whose locations are built from a connection or an uploaded file. See POST /atlases/{atlas_id}/unarchive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Create recommender via POST /recommenders. Add a new recommender. This feature is experimental and subject to change. To enable this feature, contact your account manager.

Archive a recommender via POST /recommenders/{recommender_id}/archive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Trigger a rerun for this resource via POST /recommenders/{recommender_id}/force_update.

Unarchive a recommender via POST /recommenders/{recommender_id}/unarchive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Create scope via POST /scopes. Add a new scope.

Archive a scope via POST /scopes/{scope_id}/archive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Trigger a rerun for this resource via POST /scopes/{scope_id}/force_update. Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

Unarchive a scope via POST /scopes/{scope_id}/unarchive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Archive a stream via POST /streams/{stream_id_or_name}/archive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Trigger a rerun for this resource via POST /streams/{stream_id_or_name}/force_update. Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

Unarchive a stream via POST /streams/{stream_id_or_name}/unarchive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Create a stream via POST /streams/{stream_name}. Look up (or create) an event stream by name.

Create target via POST /targets. Add a new target. Targets are configuration for exporting data from Faraday, possibly to an external environment (with <a href="https://faraday.ai/developers/reference/createconnection">/connections</a>). There are three types of targets: <table> <thead> <tr><th>Target type</th><th>Description</th><th>API requirement</th></tr> </thead> <tbody> <tr><td><strong>Publication</strong></td><td>Faraday <em>hosts</em> your predictions for convenient retrieval as needed.</td><td>Specify a <code>type</code> of <code>hosted_csv</code> in <code>options</code>. Omit <code>connection_id</code>.</td></tr> <tr><td><strong>Replication</strong></td><td>Faraday copies your predictions to systems <em>you</em> control. You may then push them to third parties like Facebook, Google Ads, etc.</td><td>Specify a valid <code>connection_id</code> and the corresponding <code>type</code> of the connection in <code>options</code>.</td></tr> <tr><td><strong>Managed</strong></td><td>Faraday manages a push to third parties like Facebook, Google Ads, and more.</td><td>Must be on an enterprise plan. Contact Customer Success to set up.</td></tr> </tbody> </table>. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard.

Archive a target via POST /targets/{target_id}/archive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Trigger a rerun for this resource via POST /targets/{target_id}/force_update. Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

Perform a lookup on the target, if its type is Lookup API via POST /targets/{target_id}/lookup. Use either PII or a spatial aggregate to retrieve the payload of a Lookup API target. See the Lookup API specification's [quickstart](https://faraday.ai/docs/features/lookup-api#retrieve-predictions) for more details, including examples.

Start a preview delivery via POST /targets/{target_id}/preview. Trigger a preview delivery (first 1000 results) of a target.

Unarchive a target via POST /targets/{target_id}/unarchive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Create a Trait via POST /traits. Create a new user-defined Trait. You can connect your uploaded data to this trait by sending a PATCH to the relevant dataset with `output_to_traits` defined.

Archive a trait via POST /traits/{trait_id}/archive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Trigger a rerun for this resource via POST /traits/{trait_id}/force_update. Trigger a rerun for this resource. Faraday automatically updates resources when their config changes, but this option is available in case of transient errors.

Unarchive a trait via POST /traits/{trait_id}/unarchive. Archiving and unarchiving CASCADE. cascade_to_all archives the resource and everything downstream of it (or, when unarchiving, everything upstream); cascade_to limits the cascade to the listed resource ids and makes the call fail rather than touch anything outside the list. Sending neither fails if any related resource would have been affected, which is the safe default.

Create webhook endpoint via POST /webhook_endpoints. Add a new webhook endpoint. The response body carries CREDENTIALS, which this integration redacts before returning it: the account object's own api_key, and any third-party secret stored in a connection's or target's options (api_key, client_secret, credentials_json, ftp_private_key, ftp_user_password, password, private_api_key, secret, token). Every other field, including the public keys Faraday generates for Snowflake and ClickHouse, comes through intact. Read a redacted value in the Faraday dashboard.