Reference

Create Dataset

Create a new dataset in Faraday to establish a data source for analysis and predictive modeling. This allows you to organize and prepare your business data for insights and forecasting.

Create Scope

Set up a new scope in Faraday to define which customer groups to target and what outcomes to measure for your predictions. This lets you organize your predictive models around specific business objectives.

Create Target

Set up a deployment destination to automatically send predictions and audience data to your CRM, ad platform, or data warehouse for real-time activation.

Create Webhook Endpoint

Register a URL to automatically receive real-time notifications when your Faraday resources are ready or encounter errors, enabling instant updates without constant manual checking.

List Accounts

Retrieves all Faraday accounts available to your user, allowing you to see account details, statuses, and IDs needed for other operations. Useful for managing multiple accounts and understanding what resources you have access to.

List Connections

View all data connections you've set up in Faraday to understand which external systems and databases are currently linked and available for syncing.

List Scopes

Retrieve all available scopes and their configurations to understand what data instructions and outputs are available for your integration setup. This helps you identify which scopes match your business needs before configuring your workflows.

Update Dataset

Modify your dataset configuration by updating properties like name, identity sets, output settings, or privacy rules without replacing the entire dataset.

Archive Cohort

Archive a cohort in Faraday to stop receiving updates while maintaining visibility of historical data and audience information. This preserves your cohort records without losing access to past insights.

Archive Connection

Safely archive a connection in Faraday to pause all data updates while maintaining your connection history and records for future reference.

Archive Dataset

Move a dataset to archived status to stop receiving updates while keeping it accessible for reference or compliance purposes. This is useful when you want to preserve historical data without actively maintaining it.

Archive Outcome

Archive an outcome to freeze its status and prevent further updates while maintaining visibility in your records. Use this when an outcome is complete or no longer actively being tracked.

Archive Persona Set

Archive a persona set to freeze it from receiving updates while maintaining visibility and historical records in your system.

Archive Place

Archive a geospatial location or address set in Faraday to pause updates while maintaining visibility and historical data for future reference.

Archive Scope

Move a scope to archived status to preserve its data and history while preventing future updates, keeping it available for reference without active monitoring.

Archive Stream

Preserves a stream's historical data while stopping future updates, keeping it accessible for reference without active monitoring or maintenance.

Archive Target

Archive a target and optionally its downstream resources in Faraday, stopping updates while keeping the resource visible for reference and compliance purposes.

Archive Trait

Archive a trait in Faraday to stop receiving updates while maintaining its visibility in your system. Use this when you want to retire a characteristic or attribute without permanently deleting it.

Create Account

Creates a new Faraday account with your chosen name and branding settings, allowing you to establish a dedicated workspace for your business operations.

Create Cohorts

Organize your customer or audience data into targeted groups based on shared characteristics, behaviors, or demographics so you can analyze patterns and run focused marketing campaigns.

Create Outcome

Create a new predictive model to forecast customer behavior patterns like conversion likelihood, churn risk, or product purchase probability. This helps you identify which customers are most likely to take specific actions so you can prioritize your sales and retention efforts.

Create Persona Set

Creates a new persona set that automatically segments your customer cohorts into distinct personas based on their shared characteristics and behaviors, helping you better understand and target different customer groups.

Create Place

Create a new geographic area or address set in Faraday that you can use to filter and organize location-based data for your business analysis and targeting.

Create Stream

Creates a new data stream or locates an existing one by name to enable event collection and tracking. Use this to set up channels for capturing and organizing different types of business events or user interactions.

Create Target Preview

Initiates a preview delivery to see how your target data will appear before making it live, allowing you to catch any issues or verify formatting beforehand.

Create Trait

Create a new trait to define and categorize facts about people or geographic entities for use in your modeling, analysis, and reporting workflows.

Delete Account

Permanently removes an account from Faraday, with the deletion processed asynchronously in the background.

Delete All Orphaned Traits

Removes all unused trait definitions from your Faraday instance that are no longer connected to any source datasets, helping keep your trait library clean and organized.

Delete Cohort

Permanently removes a cohort from your Faraday workspace, freeing up space and cleaning up your data organization. Use this when a cohort has served its purpose and you no longer need to track or reference it.

Delete Connection

Permanently removes a connection from Faraday by its unique identifier, allowing you to clean up integrations you no longer use or need to reconfigure.

Delete Dataset

Permanently removes a dataset from Faraday, freeing up storage and keeping your workspace clean. Use this when you no longer need historical data or want to declutter your analysis environment.

Delete Outcome

Remove an outcome from your Faraday workspace when it's no longer relevant or was created by mistake. This permanently deletes the outcome record and its associated data.

Delete Persona Set

Permanently remove a persona set from your Faraday account when it's no longer needed or has become obsolete. This operation cleans up your data and prevents confusion with outdated buyer personas.

Delete Place

Removes a place from your system when it's no longer needed or relevant. Use this to keep your location data clean and current.

Delete Scope

Permanently removes a scope from your Faraday system by its unique identifier. Use this when you no longer need a scope and want to clean up your workspace.

Delete Stream

Remove a stream from your Faraday account when you no longer need to monitor or process its data. This helps keep your workspace clean and focused on active data streams.

Delete Target

Remove a target from your Faraday workspace by its unique identifier, useful when you no longer need to track or test a specific asset.

Delete Upload

Permanently removes a file from your Faraday dataset directory, freeing up space and keeping your data organized.

Delete Webhook Endpoint

Remove a webhook endpoint from Faraday by its UUID when you no longer need to receive automated event notifications. This helps you manage which external services receive updates from your Faraday instance.

Force Update Cohort

Immediately rebuilds and refreshes a cohort's data without waiting for scheduled updates, ensuring you have the latest customer segments and insights.

Force Update Connection

Manually trigger a data refresh for a Faraday connection to immediately sync the latest information from your connected source. This ensures you're working with current data without waiting for the next scheduled update.

Force Update Dataset

Immediately refresh a dataset to get the latest data without waiting for scheduled updates. Use this when you need current information right away for decision-making or reporting.

Force Update Outcome

Triggers a rebuild of an outcome resource to reprocess data and update predictions without waiting for scheduled updates. This ensures you have the latest predictions based on current data.

Force Update Persona Set

Triggers an immediate reprocessing of a persona set to refresh and update all associated personas with the latest data and configurations.

Force Update Place

Triggers an immediate data refresh for a specific location in your Faraday system, ensuring you have the latest information without waiting for the next scheduled update.

Force Update Scope

Trigger a manual rerun of a scope resource to refresh its data and reprocess information when automatic updates haven't captured the latest changes you need.

Force Update Stream

Manually trigger a refresh of a data stream to rebuild its data without waiting for the next scheduled update. Useful when you need current information immediately or suspect data is out of sync.

Force Update Target

Manually trigger a rebuild or refresh of a target's data without waiting for the next scheduled update. This is useful when you need fresh data immediately or when a previous build failed.

Force Update Trait

Manually trigger a recalculation of a trait's data to refresh or rebuild its values without waiting for automatic updates.

Get Account

Retrieves detailed information about your Faraday account including status, branding, and billing details using the account UUID. Use this to access comprehensive account data whenever you need to verify your account settings or configuration.

Get Accounts Billing

Retrieve billing details, invoices, payments, and usage information for your account to track expenses and understand your service costs.

Get Cohort

Retrieve detailed information about a specific cohort, including its members, settings, and status. Use this when you need to access or verify cohort details for reporting, management, or analysis purposes.

Get Cohort Membership Analysis

Retrieve membership growth trends and changes for a specific cohort over time, helping you understand how your user groups have evolved across different periods. This is essential for tracking cohort health and identifying patterns in user retention or growth.

Get Connection Datasets

Retrieves all datasets linked to a specific connection, helping you understand which data assets depend on that connection for their data source.

Get Connection Targets

Retrieves all the destinations or endpoints that are configured to receive data through a specific connection, helping you understand how a particular connection is being used across your system.

Get Current Account

Retrieve your account details including ID, name, status, and billing information to verify account settings and monitor your subscription status.

Get Current Account Billing

Retrieve billing information including invoices, payments, and usage limits for your Faraday account to monitor costs and financial activity.

Get Dataset

Retrieve detailed information about a specific dataset including its configuration, columns, status, and metadata by providing its unique identifier.

Get Dataset Ingress Logs

Retrieve historical ingestion metrics and logs for your datasets to monitor data import performance and track how much data has been successfully processed into your system.

Get Dependency Graph

Retrieve the complete dependency graph showing how all your resources connect and interact with each other, including datasets, cohorts, outcomes, and targets. This helps you understand resource relationships and identify dependencies across your account.

Get Market Opportunity Analyses

Retrieve comprehensive market opportunity analyses including penetration rates and growth metrics to understand your competitive landscape and identify where demand exceeds current supply.

Get Outcome

Retrieve detailed information about a specific outcome including its configuration, status, and performance metrics to monitor your business goals and track their progress.

Get Persona Set

Retrieve detailed information about a specific customer persona set, including its status, configuration, and the personas it contains. Use this to access the personas you've created for your target audience segmentation.

Get Persona Set Analysis Dimensions

Retrieves detailed trait breakdowns and characteristic distributions for a group of personas, helping you understand the key attributes and patterns within your audience segments. This enables data-driven decisions about who your customers or target market actually are.

Get Persona Set Analysis Flow

Retrieve how customer personas change and shift over time, showing you which audience segments are growing, shrinking, or evolving so you can adapt your marketing strategy accordingly.

Get Place

Retrieve detailed information about a specific geographic location or address using its unique identifier, enabling you to access location data for filtering and analysis purposes.

Get Scope

Retrieve detailed information about a specific Faraday scope including its configuration, settings, and current status using its unique identifier. Use this to access scope details whenever you need to review how a scope is configured or check its operational status.

Get Scope Analysis

Analyzes scope performance and provides probability-based predictions for outcomes and recommendations, helping you understand which results are most likely based on historical data.

Get Scope Datasets

Retrieve all datasets linked to a specific Faraday scope to see what data sources and assets are available for analysis. This helps you understand your data landscape and plan your security research or analysis work.

Get Scope Efficacy

Retrieves performance metrics and accuracy measurements for a specific scope, showing how well predictions have performed over time.

Get Scope Payload Cohorts

Retrieves the list of cohorts configured within a specific scope's payload, allowing you to see which customer or data segments are included in that scope's setup. This helps you understand your audience structure and segment organization.

Get Scope Payload Outcomes

Retrieve outcome predictions and results associated with a specific scope's data payload. This helps you analyze predicted results and understand what outcomes were included in your scope analysis.

Get Scope Payload Persona Sets

Retrieves the list of persona sets configured within a specific scope's payload, allowing you to see which customer or user segments are included in your messaging setup.

Get Scope Payload Recommenders

Retrieves the recommended payload configurations and resources associated with a specific scope, helping you understand the best data structures for your integration setup.

Get Scope Population Cohorts

Retrieves the list of population cohorts associated with a specific scope, allowing you to understand the different audience segments within your data. This helps you analyze and target specific groups within your customer or user population.

Get Scope Population Exclusion Cohorts

Retrieves the list of customer cohorts that are excluded from a specific scope's population, helping you understand who is not targeted by a particular campaign or analysis.

Get Scope Targets

Retrieves all configured targets and export settings for a specific scope, allowing you to see where data is being sent and how it's configured. This helps you understand and manage your data flow setup.

Get Stream

Retrieve detailed information about a specific stream using its unique identifier or name, including its properties, event counts, and metadata.

Get Streams Analysis

Retrieves the count of stream events emitted during a specified time period, helping you understand activity patterns and event volume trends in your data streams.

Get Target

Retrieve detailed information about a specific target including its configuration, status, and export settings using its unique identifier. Use this to access target details for review, updates, or integration with other tools.

Get Target Analysis

Retrieve detailed analysis of a target audience including geographic distribution, demographic traits, and behavioral characteristics. Use this to understand who your target customers are and where they're located.

Get Trait

Retrieve detailed information about a specific trait by ID, including its type, category, properties, and configuration settings. Use this to access trait details for analysis or integration with your business processes.

Get Trait Analysis Dimensions

Retrieves demographic distribution data showing what percentage of the US population falls into each category of a specific trait, helping you understand population segments and their characteristics.

Get Traits CSV

Export all user-defined and system traits to a CSV file for analysis, reporting, or integration with other business tools. This allows you to work with trait data in spreadsheet applications and external systems.

Get Upload

Retrieve a previously uploaded file from your Faraday dataset directory to access and review its contents whenever needed.

Get Usages

Retrieve detailed usage statistics and current limits for your Faraday account to monitor feature consumption and track subscription utilization.

Get Webhook Endpoint

Retrieves detailed information about a specific webhook endpoint including its URL, status, and configuration settings. Use this to verify webhook setup, troubleshoot delivery issues, or audit your webhook endpoints.

List Attributes

Retrieve all available attributes in your feature store to understand what data is available for analysis and model building. This helps you discover and catalog the attributes you can use for data-driven decisions.

List Cohorts

Retrieve all customer cohorts or segments from your Faraday account to understand how your customers are grouped and organized.

List Feature Stores

Retrieves all feature stores from your Faraday account, allowing you to view and manage your stored data features in one place.

List Outcomes

Retrieve all configured business objectives and outcomes for your account to review performance goals and their current modeling status.

List Persona Sets

Retrieve all your customer persona sets to identify and understand your target audience segments. Use this to review and select the personas that best represent your customers for marketing and product decisions.

List Places

Retrieve all your geospatial areas and address sets from Faraday to use for filtering and organizing location-based data. Helps you quickly access your configured places without manual lookup.

List Recommenders

Retrieve all available recommender resources that analyze event streams to predict future associations and behaviors. Use this to see what predictive tools are available for your business data.

List Streams

Retrieve all event streams associated with your Faraday account to see what data sources and integrations are actively collecting information.

List Targets

View all targets configured in your Faraday account to understand your available export destinations for predictions and data outputs.

List Uploaded Files

Retrieve a list of all files you've previously uploaded to Faraday, allowing you to verify uploads and locate existing datasets without having to navigate the interface manually.

List Webhook Endpoints

Retrieve all webhook endpoints configured for your account, including their URLs, status, and which events they're monitoring. Use this to audit your integrations and verify that all your automated workflows are properly connected.

Unarchive Cohort

Restore an archived cohort and make it active again in your system, optionally recovering any related upstream resources that were archived with it.

Unarchive Dataset

Restores an archived dataset in Faraday, making it available for active use again. This is helpful when you need to work with data you previously archived but no longer need to keep hidden.

Unarchive Outcome

Restore a previously archived outcome to make it active again and resume tracking its updates. Use this when you need to revisit or continue work on a goal or project that was temporarily shelved.

Unarchive Persona Set

Restore a previously archived persona set back to active status, making it available for use in your customer profiling and targeting workflows.

Unarchive Place

Restore a previously archived place in Faraday, making it active and accessible again along with its related resources if needed.

Unarchive Scope

Restore a previously archived scope in Faraday and optionally recover its connected upstream resources for active use again.

Unarchive Stream

Restore an archived stream in Faraday back to active use, optionally restoring related upstream resources as well. Use this when you need to resume work on a previously archived data stream.

Unarchive Trait

Restore a previously archived trait back to active use, optionally recovering any upstream resources that were archived with it.

Update Account

Modify your account's name, branding settings, and other key properties to keep your business information current and aligned with your brand identity.

Update Cohort

Modify an existing cohort's settings such as name, filters, and conditions to keep your audience segments current and aligned with your business goals.

Update Connection

Modify an existing Faraday connection's configuration, such as updating its name or connection settings without needing to recreate it entirely.

Update Outcome

Modify an outcome's settings and properties like name, assigned cohorts, bias mitigation rules, or prediction mode to keep your predictive models aligned with your business goals. This lets you refine how Faraday analyzes and predicts outcomes without recreating them from scratch.

Update Persona Set

Modify an existing persona set's configuration, such as its name, visibility settings, clustering parameters, or preview mode to match your evolving audience research needs.

Update Place

Modify a place's name, addresses, or geographic boundaries to keep your location data current and accurate. This is useful when business details change or location information needs correction.

Update Scope

Modify a Faraday scope's configuration including its name, payload settings, cohorts, and preview status to fine-tune your experiment or feature rollout parameters.

Update Stream

Modify a stream's properties like description, category, or status to keep your data infrastructure organized and up-to-date. Use this when you need to refine how streams are documented and categorized in your system.

Update Target

Modify a target's settings and properties in Faraday to keep your vulnerability assessment configurations current and aligned with your security needs.

Update Trait

Modify trait properties such as descriptions, display names, lookup tables, statistical classifications, or measurement units to keep your data definitions accurate and organized.

Update Webhook Endpoint

Modify an existing webhook endpoint's settings including its status, URL, or which events it listens to. Use this when you need to change how your webhook responds to platform events without recreating it.