Faraday

Tool to list all outcomes for the account. Use when you need to retrieve configured business objectives and their modeling status. Returns complete list without pagination.

Tool to list all persona sets. Use when you need to retrieve customer persona sets for analysis or selection.

Tool to list all scopes. Use when you need to retrieve scope configurations for viewing output data instructions.

Tool to list all targets in your Faraday account. Use when you need to view export configurations for predictions.

Tool to retrieve detailed information about a Faraday account by its UUID. Use when you need to fetch account details, status, branding, or billing information.

Tool to get billing information about your account. Use when you need to retrieve invoices, payments, or usage information for a specific account.

Tool to get cohort membership counts over time for a specific cohort. Use when you need to analyze how cohort membership has changed over days, weeks, and months.

Tool to retrieve all datasets that use a specific connection. Use when you need to list datasets associated with a connection ID.

Tool to retrieve all targets that use a specific connection. Use when you need to get a list of all targets associated with a connection ID.

Tool to retrieve dataset ingress metrics over time. Use when you need to monitor or analyze data ingestion history, track row counts, or review ingress operation status for a specific dataset.

Tool to retrieve the complete dependency graph for all resources on an account. Shows relationships between datasets, cohorts, outcomes, targets, connections, and other resources.

Tool to retrieve all market opportunity analyses from Faraday. Use when you need to view penetration and opportunity metrics in your market.

Tool to get various trait breakdown information about a persona set. Use when you need to analyze the characteristics and distributions of personas within a set.

Tool to retrieve the flow of persona sets over time, showing how individuals move between different personas. Use when you need to analyze trends in persona membership or understand how your audience segments are evolving over time.

Tool to retrieve a specific place by its UUID. Use when you need to get details about a geospatial area or address set that can be used as a spatial filter.

Tool to get analysis for a scope including outcomes and recommenders with probability distributions. Use when you need to analyze scope performance and understand prediction distributions.

Tool to retrieve all datasets associated with a Faraday scope. Use when you need to list or view all datasets that are connected to a specific scope.

Tool to retrieve efficacy metrics for a scope. Returns model performance metrics and accuracy measurements showing how well predictions performed over time.

Tool to get payload cohorts for a specific scope. Use when you need to retrieve the list of cohorts included in a scope's payload configuration.

Tool to retrieve payload outcomes for a specific scope. Use when you need to fetch the outcome predictions included in a scope's data payload.

Tool to get payload persona sets for a specific scope. Use when you need to retrieve the list of persona sets included in a scope's payload configuration.

Tool to retrieve payload recommenders for a specific scope. Use when you need to fetch recommender resources associated with a scope's payload configuration.

Tool to get population cohorts for a specific scope. Use when you need to retrieve the list of cohorts associated with a scope's population.

Tool to get population exclusion cohorts for a scope. Use when you need to retrieve the cohorts that are excluded from a specific scope's population.

Tool to get all targets for a specific scope. Use when you need to retrieve export configurations and target details for a scope.

Tool to retrieve a stream by its UUID or name. Use when you need to fetch stream details including properties, event counts, and metadata.

Tool to get the count of stream events emitted over a time period. Use when you need to analyze stream activity patterns and event volume trends.

Tool to retrieve a target's analysis including geographic distributions and trait breakdowns. Use when you need to understand the composition and characteristics of individuals within a specific target.

Tool to retrieve a specific trait by ID. Use when you need to get detailed information about a trait including its type, category, statistical properties, and configuration.

Tool to retrieve the percentage of the US population that falls into each category of a trait. Use when you need to analyze the distribution of a specific trait across the population.

Tool to retrieve all user-defined and Faraday-provided traits in CSV format. Use when you need to export or analyze trait data in a spreadsheet-compatible format.

Tool to download a previously uploaded file from a Faraday dataset directory. Use when you need to retrieve the contents of a specific file.

Tool to retrieve usage statistics for your Faraday account. Use when you need to check current usage and limits for various account features.

Tool to retrieve a webhook endpoint by its UUID. Use when you need to access details about a specific webhook endpoint including its URL, status, enabled events, and signing secret.

Tool to list all Faraday accounts accessible by the current user. Use when you need to retrieve account information, check account status, or get account IDs for other operations.

Tool to list all attributes in the feature store. Use when you need to retrieve the catalog of available attributes for data analysis or feature engineering.

Tool to list all feature stores. Use when you need to retrieve feature stores from your Faraday account.

Tool to list all places in Faraday. Use when you need to retrieve geospatial areas or address sets that can be used as spatial filters. Returns all place resources with their status and configuration.

Tool to list all recommenders. Use when you need to retrieve recommender resources that predict future associations based on event streams.

Tool to list all streams in your Faraday account. Use when you need to retrieve event streams associated with the account.

Tool to retrieve the list of previously uploaded files in Faraday. Use when you need to see uploaded datasets or verify file uploads.

Tool to list all webhook endpoints configured for the account. Use when you need to retrieve webhook endpoint information including URLs, status, and enabled events.

Tool to create a new trait in Faraday. Use when you need to define a new fact about a person or geographic entity that can be used in modeling, analysis, and reporting.

Tool to create a new webhook endpoint. Use when you need to register a webhook URL to receive notifications when resources are ready or encounter errors.

Tool to archive an outcome in Faraday. Use when you need to stop updates to an outcome while keeping it visible.

Tool to archive a persona set in Faraday. Use when you need to stop updates to a persona set while keeping it visible.

Tool to archive a place in Faraday. Use when you need to stop updates to a geospatial area or address set while keeping it visible.

Tool to archive a scope in Faraday. Use when you need to stop updates to a scope while keeping it visible.

Tool to archive a stream in Faraday. Use when you need to archive a stream and optionally its downstream resources. Archiving stops updates to the resource but keeps it visible.

Tool to archive a target in Faraday. Use when you need to archive a target and optionally its downstream resources. Archiving stops updates to the resource but keeps it visible.

Tool to trigger a rerun for a Faraday connection. Use when you need to force refresh connection data.

Tool to trigger a rerun for a dataset. Use when you need to force a dataset to update immediately rather than waiting for its normal schedule.

Tool to trigger a rerun for a persona set resource. Use when you need to force rebuild a persona set, causing it to reprocess and update its personas.

Tool to trigger a rerun for a place. Use when you need to force rebuild a place's data.

Tool to trigger a rerun for a stream. Use when you need to force rebuild a stream's data.

Tool to trigger a rerun for a trait. Use when you need to force rebuild a trait's data.

Tool to unarchive a previously archived cohort. Use when you need to restore an archived cohort and optionally its upstream resources.

Tool to unarchive a dataset in Faraday. Use when you need to restore an archived dataset for active use. Optionally cascades to upstream resources.

Tool to unarchive an outcome in Faraday. Use when you need to restore updates to a previously archived outcome.

Tool to unarchive a previously archived persona set. Use when you need to restore an archived persona set and optionally its upstream resources.

Tool to unarchive a previously archived place. Use when you need to restore an archived place and optionally its upstream resources.

Tool to unarchive a previously archived scope. Use when you need to restore an archived scope and optionally its upstream resources.

Tool to unarchive a stream in Faraday. Use when you need to restore an archived stream for active use. Optionally cascades to upstream resources.

Tool to unarchive a trait. Use when you need to restore an archived trait and optionally its upstream resources.

Tool to update an account's name or branding settings. Use when you need to modify account properties using JSON Merge Patch semantics.

Tool to update a Faraday connection's name or options. Use when you need to modify connection properties using JSON Merge Patch semantics.

Tool to update a dataset configuration using JSON Merge Patch semantics. Use when you need to modify dataset properties like name, identity sets, output configurations, or privacy settings.

Tool to edit a persona set's configuration using JSON Merge Patch. Use when you need to update persona set properties like name, explore visibility, number of clusters, or preview mode.

Tool to update a place's name, addresses, or geojson geometry. Use when you need to modify place properties using JSON Merge Patch semantics.

Tool to update a stream's properties using JSON Merge Patch semantics. Use when you need to modify stream metadata like description, category, or deprecation status.

Tool to update a trait's properties using JSON Merge Patch semantics. Use when you need to modify trait metadata like description, literate name, lookup table, statistical type, or unit.

Tool to update a webhook endpoint's configuration. Use when you need to modify the status, URL, or enabled events for an existing webhook endpoint.

Tool to delete a place by its UUID. Use when you need to remove a place from the system.

Tool to delete a stream by its UUID or name. Use when you need to remove a stream that is no longer needed.

Tool to delete a target by its UUID. Use when you need to remove a target from Faraday.

Permanently deletes a file from a Faraday dataset directory. Use this when you need to remove an uploaded file from a specific directory. This is a destructive operation that cannot be undone - the file will be permanently removed from the specified directory.

Tool to delete a webhook endpoint by its UUID. Use when you need to remove a webhook endpoint from Faraday. The operation returns 204 No Content on success.