# Docs ## API - [Api](/docs/API): Integrate Alviss AI into your systems using our comprehensive API. Learn about authentication with Bearer tokens, managing access tokens via your account, creating new tokens with expiration dates, and revoking them for enhanced security. ## Activities - [Activities](/docs/Activities): Dive into the Activities dashboard in Alviss AI, your essential tool for visualizing and analyzing raw data from active datasets. Track metrics like sales, investments, and trends through dynamic overviews, graphs, and visuals. Learn key features, best practices for data validation, filtering, exploratory analysis, and team collaboration to identify patterns and ensure reliable insights. ## Correlation - [Correlation](/docs/Correlation): Measure pairwise correlations between variables using Pearson, Spearman, and Kendall methods. ## Data%20Explorer - [Data Explorer](/docs/Data%20Explorer): Visually inspect and compare dataset variables using interactive charts and statistics. ## Effect - [Effect](/docs/Effect): Use Effect dashboard to visualize how drivers impact commercial objectives based on AI models and data. Key features include detailed breakdowns of KPI influences, filtering for focused analysis on variables, regions, or periods, and tooltips for contextual explanations to aid data-driven decision-making and strategic planning. ## Feature%20Importance - [Feature Importance](/docs/Feature%20Importance): Rank variables by their predictive importance for a target using gradient boosting and permutation importance. ## Filtering - [Filtering](/docs/Filtering): Learn about filtering in Alviss AI for precise data analysis. ## Optimizations - [Optimizations](/docs/Optimizations): Use Alviss AI's optimization feature to automate variable adjustments for simulations and predictions, maximizing or minimizing KPIs under constraints. Select dynamic or goal-driven modes, date ranges with pre/post periods, targets, variables, boundaries, and directions. ## Predictions - [Predictions](/docs/Predictions): Forecast future outcomes in Alviss AI using Predictions to project KPIs like sales or revenue based on customizable drivers. Set variables for granular control, run multiple scenarios for comparisons, and analyze results with time-series graphs, confidence intervals, and filters. Leverage for demand preparation, strategy optimization, and integration with attributions or optimizations. ## Projects - [Projects](/docs/Projects): Manage workflows in Alviss AI with projects as self-contained workspaces for datasets, models, and insights. ## Response%20Curves - [Response Curves](/docs/Response%20Curves): Visualize variable impacts on KPIs with Response Curves in Alviss AI, identifying ex. saturation points. ## Simulations - [Simulations](/docs/Simulations): Compare scenarios against baselines in Alviss AI Simulations to uncover optimal actions and synergies, highlighting differences in KPIs like revenue or churn. ## Teams - [Teams](/docs/Teams): Collaborate in Alviss AI with team-based workflows for shared access to resources like compute, storage, and datasets. Administer members via invites/removals, exit or delete teams, and integrate via API for efficient model development and data reliability. ## undefined - [Introduction](/docs): Explore Alviss AI, a platform for holistic business measurement and optimization. Gain insights into drivers like pricing, marketing, distribution, macro economy, and customer experience to enhance KPIs such as sales and churn. Learn about data-driven decision making, identifying growth opportunities, optimizing processes, and improving customer experience. ## Attributions - [Working With Attributions](/docs/Attributions/Working%20with%20Attributions): Guide to working with attributions in Alviss AI. Create new ones by selecting models, dates, and baselines (default or custom for business relevance), analyze via dashboards and explore tabs. Group into attributionsets for aggregated views, handle overlaps, extend for continuity. Activate for Effect dashboard, ensure results by verifying impact direction and magnitude. - [Attributions](/docs/Attributions): Understand attribution in Alviss AI as the process of measuring business components' impact on outcomes like sales via baseline and observed predictions, calculating differences for actionable insights. ## Data - [Datasets](/docs/Data/Datasets): Organize data in Alviss AI with Datasets that group compatible uploads into immutable collections for models, simulations, predictions etc. - [External Data](/docs/Data/External%20Data): Enhance models in Alviss AI with built-in external data for weather and macroeconomic indicators. - [Interpolation And Extrapolation](/docs/Data/Interpolation%20and%20Extrapolation): undefined - [Uploads](/docs/Data/Uploads): Manage uploaded data files in Alviss AI via the Uploads section for tracking, inspection and integration into Datasets. - [Data](/docs/Data): Explore data requirements in Alviss AI - [Brand](/docs/Data/Files/Brand): Provide Brand data in Alviss AI for metrics on perception like awareness, liking, and NPS, to quantify impact on sales and KPIs. - [Competitor Brand](/docs/Data/Files/Competitor%20Brand): Provide Competitor Brand data in Alviss AI for metrics like awareness, liking, penetration, and recommendation to model competitive effects on sales, KPIs, and market share. - [Competitor Distribution](/docs/Data/Files/Competitor%20Distribution): Provide Competitor Distribution data in Alviss AI for metrics on rivals' presence like stores, agents, or offices to model impacts on sales, market share, and KPIs. - [Competitor Media](/docs/Data/Files/Competitor%20Media): Provide Competitor Media data in Alviss AI for advertising investments by rivals across channels like Display, Facebook, or TV, segmented by product and media type to model impacts on sales, KPIs, and positioning. - [Competitor Price](/docs/Data/Files/Competitor%20Price): Provide Competitor Price data in Alviss AI for pricing info on rivals' products like average selling prices or discounts, to model elasticity, competitive effects on sales, demand, and KPIs. - [Customer Experience](/docs/Data/Files/Customer%20Experience): Provide Customer Experience data in Alviss AI for investments in interactions satisfaction and loyalty e.g. IT HR training to estimate ROI and impact on retention sales KPIs. - [Distribution](/docs/Data/Files/Distribution): undefined - [Events](/docs/Data/Files/Events): Provide Events data in Alviss AI for time-bound occurrences like Force Majeure strikes outages to model disruptions on operations sales KPIs. - [Extra](/docs/Data/Files/Extra): Provide Extra data in Alviss AI for custom variables like agreements supply chain inquiries that influence models but don't fit standard categories. - [Macro](/docs/Data/Files/Macro): Provide Macroeconomic data in Alviss AI for indicators like unemployment CCI CPI interest rates to model economic impacts on consumer behavior KPIs. - [Media](/docs/Data/Files/Media): Provide Media data in Alviss AI for advertising investments campaigns by product media type campaign metrics like Impression Investment GRP Reach Clicks Leads Gross to model ROI channel performance impacts. - [Sales](/docs/Data/Files/Sales): Provide Sales data in Alviss AI as core dataset for outcomes like revenue volume with units sold price per unit optional profit. - [Visits](/docs/Data/Files/Visits): Provide Visits data in Alviss AI for traffic metrics like website store visits to model consumer engagement funnel efficiency impacts on conversions sales KPIs. - [Weather](/docs/Data/Files/Weather): Provide Weather data in Alviss AI for meteorological indicators like precipitation wind temperature snow humidity sunshine to model environmental impacts on demand KPIs. - [Files](/docs/Data/Files): Overview of supported data types in Alviss AI for business modeling - [Country](/docs/Data/Format/Country): Provide Country field in Alviss AI using three-letter uppercase ISO 3166-1 alpha-3 codes for global data consistency accuracy. - [Date](/docs/Data/Format/Date): The rules for how dates needs to be formated when uploaded in to the Alviss AI platform. - [File Format](/docs/Data/Format/File%20Format): Upload files to Alviss AI in CSV or Excel format with strict rules for separators decimals structure headers encoding and data consistency. - [Grouping](/docs/Data/Format/Grouping): Use the Grouping field in Alviss AI as flexible option for custom segmentation like product lines customer types sales channels or store locations beyond geography enabling granular analysis filtering and targeted modeling. - [Periodicity](/docs/Data/Format/Periodicity): Set consistent time interval for all project datasets e.g. Minute, Hour, Day, Week, Month, Quarter, Year. - [Region](/docs/Data/Format/Region): Define Region field in Alviss AI as flexible string for country subdivisions geographic areas or custom territories enabling granular analysis filtering modeling. ## Models - [Active Model](/docs/Models/Active%20Model): Designate a model in Alviss AI as the default, to automatically be used it in dashboards, simulations, predictions etc. - [Basic Model Builder](/docs/Models/Basic%20Model%20Builder): Use the Basic Model Builder in Alviss AI for fast model creation with automated defaults. - [Modeling Combination](/docs/Models/Modeling%20Combination): Structure models in Alviss AI around unique combinations of Country Region and Grouping for granular targeted insights. - [Prior vs Posterior](/docs/Models/Prior%20vs%20Posterior): Visualize how model parameters shift from prior assumptions to learned posteriors after fitting. - [Models](/docs/Models): Create and manage AI models in Alviss AI to get data driven insights. - [Advanced Model Builder](/docs/Models/Advanced%20Model%20Builder/Advanced%20Model%20Builder): Use the Advanced Model Builder in Alviss AI for precise control over complex business and marketin models. - [Graph Editor](/docs/Models/Advanced%20Model%20Builder/Graph%20Editor): Master the Graph Editor in Alviss AI for efficient model building. - [Templates](/docs/Models/Advanced%20Model%20Builder/Templates): Accelerate model building in Alviss AI with pre-configured templates in the Advanced Model Builder's Graph Editor. ## users - [Permissions And Roles](/docs/users/Permissions%20and%20Roles): Use team member roles in Alviss AI for team access control. - [Users](/docs/users/Users): Manage your Alviss AI account via Your Account page to update personal details. # API ## info - [Get Currencies](/api/info/get_currencies_info_currencies_get): Get supported currencies. - [Get External Macro Info](/api/info/get_external_macro_info_info_datasource_get): Get external data source info. - [Get Data Formats](/api/info/get_data_formats_info_data_formats_get): Get data formats. ## data-uploads - [Get Dataupload Example](/api/data-uploads/get_dataupload_example_info_example_datauploads_get): Get data file example from the data specification. - [List Datauploads](/api/data-uploads/list_datauploads_projects__team_id___project_id__datauploads_get): Get list of data uploads. - [Upload Data](/api/data-uploads/upload_data_projects__team_id___project_id__datauploads_post): Upload a data file. - [Bulk Delete Datauploads](/api/data-uploads/bulk_delete_datauploads_projects__team_id___project_id__datauploads_delete): Bulk delete data uploads matching the given filters. - [Get Dataupload](/api/data-uploads/get_dataupload_projects__team_id___project_id__datauploads__item_id__get): Get a dataupload info. - [Update Dataupload](/api/data-uploads/update_dataupload_projects__team_id___project_id__datauploads__item_id__patch): Update a dataupload's note. - [Delete Dataupload](/api/data-uploads/delete_dataupload_projects__team_id___project_id__datauploads__item_id__delete): Delete a dataupload file. - [Get External Dataupload Indicators](/api/data-uploads/get_external_dataupload_indicators_projects__team_id___project_id__datauploads__item_id__external_indicators_get): Get list of indicators for external datasource per country. - [Get Dataupload Dates Min Max](/api/data-uploads/get_dataupload_dates_min_max_projects__team_id___project_id__datauploads__item_id__dates_min_max_get): Get min and max data dates for a data upload. - [Downalod Dataupload](/api/data-uploads/downalod_dataupload_projects__team_id___project_id__datauploads__item_id__data_get): Get a dataupload in csv format and would exclude auto-generated variables. - [Download Interpolated Upload](/api/data-uploads/download_interpolated_upload_projects__team_id___project_id__datauploads__item_id__interpolate_variable_data_get): Download a dataimport interpolated variable as csv. - [Download Interpolated Upload Query](/api/data-uploads/download_interpolated_upload_query_projects__team_id___project_id__datauploads__item_id__interpolate_variable_data_query_post): Download dataimport interpolated variable — POST variant for large filter payloads. ## projects - [List Projects](/api/projects/list_projects_projects__team_id__get): List available projects. - [Create Project](/api/projects/create_project_projects__team_id__post): Create a new project. - [Get Project](/api/projects/get_project_projects__team_id___project_id__get): Get a project info. - [Update Project](/api/projects/update_project_projects__team_id___project_id__patch): Update a project. - [Delete Project](/api/projects/delete_project_projects__team_id___project_id__delete): Delete a project. - [Get Project Active History](/api/projects/get_project_active_history_projects__team_id___project_id__active_history_get): Return activation/deactivation events for this project, grouped by type. - [Get Project Resources](/api/projects/get_project_resources_projects__team_id___project_id__resources_get): Get list of resources from a project. - [Get Model Quality Rules](/api/projects/get_model_quality_rules_projects__team_id___project_id__model_quality_rules_get): Return all model quality rules for a project (empty list if none stored). - [Put Model Quality Rules](/api/projects/put_model_quality_rules_projects__team_id___project_id__model_quality_rules_put): Reconcile the project's rules against the incoming set. ## datasets - [List Datasets](/api/datasets/list_datasets_projects__team_id___project_id__datasets_get): List datasets. - [Create Dataset](/api/datasets/create_dataset_projects__team_id___project_id__datasets_post): Create a new dataset. - [Bulk Delete Datasets](/api/datasets/bulk_delete_datasets_projects__team_id___project_id__datasets_delete): Bulk delete datasets matching the given filters. - [List Dataset Active History](/api/datasets/list_dataset_active_history_projects__team_id___project_id__datasets_active_history_get): List the history of active dataset changes for this project. - [Activate Dataset](/api/datasets/activate_dataset_projects__team_id___project_id__datasets__dataset_id__activate_post): Activate a dataset. - [Deactivate Dataset](/api/datasets/deactivate_dataset_projects__team_id___project_id__datasets__dataset_id__activate_delete): Deactivate the active dataset. - [Get Dataset](/api/datasets/get_dataset_projects__team_id___project_id__datasets__dataset_id__get): Get details of a dataset. - [Update Dataset](/api/datasets/update_dataset_projects__team_id___project_id__datasets__dataset_id__patch): Update dataset attributes. - [Delete Dataset](/api/datasets/delete_dataset_projects__team_id___project_id__datasets__dataset_id__delete): Delete a dataset. - [List Dataset Variable Limits](/api/datasets/list_dataset_variable_limits_projects__team_id___project_id__datasets__dataset_id__variable_limits_get): List per-variable, per-modelling-combination limits for a dataset. - [Patch Dataset Variable Limits](/api/datasets/patch_dataset_variable_limits_projects__team_id___project_id__datasets__dataset_id__variable_limits_patch): Bulk-update dataset-level variable limits. - [Download Dataset](/api/datasets/download_dataset_projects__team_id___project_id__datasets__dataset_id__data_get): Download dataset data. - [Download Variable](/api/datasets/download_variable_projects__team_id___project_id__datasets__dataset_id__variable_data_get): Download dataset variable data. - [Download Variable Query](/api/datasets/download_variable_query_projects__team_id___project_id__datasets__dataset_id__variable_data_query_post): Download dataset variable data — POST variant for large filter payloads. - [Download Archive](/api/datasets/download_archive_projects__team_id___project_id__datasets__dataset_id__archive_get): Download dataset as a zip file. - [List Variables](/api/datasets/list_variables_projects__team_id___project_id__datasets__dataset_id__variable_get): List dataset variables. - [List Variables Post ](/api/datasets/list_variables_post__projects__team_id___project_id__datasets__dataset_id__variable_post): List dataset variables. - [List Variable Importance](/api/datasets/list_variable_importance_projects__team_id___project_id__datasets__dataset_id__importantce_post): List variable importance for a dataset. - [List Variable Correlation](/api/datasets/list_variable_correlation_projects__team_id___project_id__datasets__dataset_id__correlation_post): List variable correlation for a dataset. - [List Modelling Combinations](/api/datasets/list_modelling_combinations_projects__team_id___project_id__datasets__dataset_id__modelling_combinations_get): List modelling combinations for a dataset. - [Get Dates](/api/datasets/get_dates_projects__team_id___project_id__datasets__dataset_id__dates_get): List dates for a dataset for a single modelling combination. - [Get Dates Multiple Modeling Combintions](/api/datasets/get_dates_multiple_modeling_combintions_projects__team_id___project_id__datasets__dataset_id__dates_post): Get dates for multiple modelling combinations. - [Get Dataset Dates Min Max](/api/datasets/get_dataset_dates_min_max_projects__team_id___project_id__datasets__dataset_id__dates_min_max_get): Get min and max dates from dataset data. - [List Valid Models](/api/datasets/list_valid_models_projects__team_id___project_id__datasets__dataset_id__valid_models_get): List of valid models for a dataset. ## feature-importance - [List Feature Importance](/api/feature-importance/list_feature_importance_projects__team_id___project_id__importance_get): List feature importance jobs. - [Submit Feature Importance Calculation](/api/feature-importance/submit_feature_importance_calculation_projects__team_id___project_id__importance_post): Submit a feature importance job. - [Get Feature Importance](/api/feature-importance/get_feature_importance_projects__team_id___project_id__importance__importance_id__get): Get details of a feature importance job. - [Delete Feature Importance](/api/feature-importance/delete_feature_importance_projects__team_id___project_id__importance__importance_id__delete): Delete a feature importance job. - [Download Feature Importance](/api/feature-importance/download_feature_importance_projects__team_id___project_id__importance__importance_id__data_get): Download feature importance job data. ## variables - [List Variable Overwrites](/api/variables/list_variable_overwrites_projects__team_id___project_id__variable_overwrites_get): List variable overwrites for a variable. - [Post Variable Overwrites](/api/variables/post_variable_overwrites_projects__team_id___project_id__variable_overwrites_post): Add variable overwrites in a project. - [List Variables](/api/variables/list_variables_projects__team_id___project_id__variables_get): List variables. - [Update Varaible](/api/variables/update_varaible_projects__team_id___project_id__variables__var_id__patch): Update a variable. - [List Variable Util Overrides](/api/variables/list_variable_util_overrides_projects__team_id___project_id__variable_util_overrides_get): List util_attr relabels for the project, optionally filtered by Type. - [Post Variable Util Overrides](/api/variables/post_variable_util_overrides_projects__team_id___project_id__variable_util_overrides_post): Bulk upsert per-type util_attr relabels. - [Patch Variable Util Overrides](/api/variables/patch_variable_util_overrides_projects__team_id___project_id__variable_util_overrides__var_type__patch): Set or clear util_attr relabels for a single variable Type. ## models - [List Graphs](/api/models/list_graphs_projects__team_id___project_id__build_graphs_get): List saved graph structures for model building. - [Save Graph](/api/models/save_graph_projects__team_id___project_id__build_graphs_post): Save a graph structure for reuse in model building. - [Get Graph](/api/models/get_graph_projects__team_id___project_id__build_graphs__graph_id__get): Get a graph by ID. - [Update Graph](/api/models/update_graph_projects__team_id___project_id__build_graphs__graph_id__patch): Update a graph. - [Build A Model](/api/models/build_a_model_projects__team_id___project_id__build_model_post): Train a new ML model for forecasting business KPIs. - [Build Multiple Models](/api/models/build_multiple_models_projects__team_id___project_id__build_model_multiple_post): Train multiple ML models for different market segments in batch. - [Get Basic Graph](/api/models/get_basic_graph_projects__team_id___project_id__build_graph_basic_post): Get default graph. - [List Basic Graph Tasks](/api/models/list_basic_graph_tasks_projects__team_id___project_id__build_graph_basic_job_get): Get list of graph jobs. - [Submit Basic Graph Task](/api/models/submit_basic_graph_task_projects__team_id___project_id__build_graph_basic_job_post): Get default graph. - [Get Graph Basic Task](/api/models/get_graph_basic_task_projects__team_id___project_id__build_graph_basic_job__job_id__get): Get graph job result from capability via drun. - [Delete Basic Graph Task](/api/models/delete_basic_graph_task_projects__team_id___project_id__build_graph_basic_job__job_id__delete): Delete graph job. - [Get Synergy Models Graph](/api/models/get_synergy_models_graph_projects__team_id___project_id__build_graph_synergy_models_post): Get synergy models graph. - [List Synergy Graph Tasks](/api/models/list_synergy_graph_tasks_projects__team_id___project_id__build_graph_synergy_models_job_get): Get list of synergy models graph jobs. - [Submit Synergy Graph Task](/api/models/submit_synergy_graph_task_projects__team_id___project_id__build_graph_synergy_models_job_post): Submit synergy models graph job. - [Get Synergy Graph Task](/api/models/get_synergy_graph_task_projects__team_id___project_id__build_graph_synergy_models_job__job_id__get): Get synergy models graph job result. - [Delete Synergy Graph Task](/api/models/delete_synergy_graph_task_projects__team_id___project_id__build_graph_synergy_models_job__job_id__delete): Delete synergy models graph job. - [List Models](/api/models/list_models_projects__team_id___project_id__models_get): List all trained models in the project with optional filtering. - [Bulk Delete Models](/api/models/bulk_delete_models_projects__team_id___project_id__models_delete): Bulk delete models matching the given filters. - [List Model Active History](/api/models/list_model_active_history_projects__team_id___project_id__models_active_history_get): List the history of active model changes for this project. - [Get Model](/api/models/get_model_projects__team_id___project_id__models__model_id__get): Get detailed information about a specific model. - [Update Model](/api/models/update_model_projects__team_id___project_id__models__model_id__patch): Update metadata attributes of a model. - [Delete Model](/api/models/delete_model_projects__team_id___project_id__models__model_id__delete): Delete a model and its associated data. - [Activate Model](/api/models/activate_model_projects__team_id___project_id__models__model_id__activate_post): Set a model as the active model for its market segment. - [Deactivate Model](/api/models/deactivate_model_projects__team_id___project_id__models__model_id__activate_delete): Deactivate the active model for its market segment. - [Project Model Target Nodes](/api/models/project_model_target_nodes_projects__team_id___project_id__model_target_nodes_get): Get the distinct target Variables across all models in a project. - [Project Model Result Nodes](/api/models/project_model_result_nodes_projects__team_id___project_id__model_result_nodes_get): Get the distinct result Variables across all models in a project. - [Project Model Input Nodes](/api/models/project_model_input_nodes_projects__team_id___project_id__model_input_nodes_get): Get the distinct input Variables across all models in a project. - [Get Valid Datasets](/api/models/get_valid_datasets_projects__team_id___project_id__models__model_id__valid_datasets_get): List datasets compatible with this model for refit or prediction. - [Refit Model](/api/models/refit_model_projects__team_id___project_id__models__model_id__refit_post): Retrain an existing model with new data or parameters. ## simulations - [List Simulations](/api/simulations/list_simulations_projects__team_id___project_id__simulations_get): List all simulation jobs in the project with optional filtering. - [Submit Simulation](/api/simulations/submit_simulation_projects__team_id___project_id__simulations_post): Submit a simulation job to compare baseline vs scenario forecasts. - [Bulk Delete Simulations](/api/simulations/bulk_delete_simulations_projects__team_id___project_id__simulations_delete): Bulk delete simulation jobs matching the given filters. - [Get Simulation](/api/simulations/get_simulation_projects__team_id___project_id__simulations__simulation_id__get): Get detailed information about a specific simulation job. - [Update Simulation](/api/simulations/update_simulation_projects__team_id___project_id__simulations__simulation_id__patch): Update metadata attributes of a simulation job. - [Delete Simulation](/api/simulations/delete_simulation_projects__team_id___project_id__simulations__simulation_id__delete): Delete a simulation job and its associated data. - [Get Simulation Dates Min Max](/api/simulations/get_simulation_dates_min_max_projects__team_id___project_id__simulations__simulation_id__dates_min_max_get): Get min and max dates from simulation result data. - [Download Simulation](/api/simulations/download_simulation_projects__team_id___project_id__simulations__simulation_id__data_get): Download simulation results as a CSV file. - [Download Simulation Query](/api/simulations/download_simulation_query_projects__team_id___project_id__simulations__simulation_id__data_query_post): Download simulation results — POST variant for large filter payloads. ## predictions - [List Predictions](/api/predictions/list_predictions_projects__team_id___project_id__predictions_get): List all prediction jobs in the project with optional filtering. - [Submit Prediction](/api/predictions/submit_prediction_projects__team_id___project_id__predictions_post): Submit a prediction job to forecast KPIs using trained ML models. - [Bulk Delete Predictions](/api/predictions/bulk_delete_predictions_projects__team_id___project_id__predictions_delete): Bulk delete prediction jobs matching the given filters. - [Get Prediction](/api/predictions/get_prediction_projects__team_id___project_id__predictions__prediction_id__get): Get detailed information about a specific prediction job. - [Update Prediction](/api/predictions/update_prediction_projects__team_id___project_id__predictions__prediction_id__patch): Update metadata attributes of a prediction job. - [Delete Prediction](/api/predictions/delete_prediction_projects__team_id___project_id__predictions__prediction_id__delete): Delete a prediction job and its associated data. - [Get Prediction Dates Min Max](/api/predictions/get_prediction_dates_min_max_projects__team_id___project_id__predictions__prediction_id__dates_min_max_get): Get min and max dates from prediction result data. - [Download Prediction](/api/predictions/download_prediction_projects__team_id___project_id__predictions__prediction_id__data_get): Download prediction results as a CSV file. - [Download Prediction Query](/api/predictions/download_prediction_query_projects__team_id___project_id__predictions__prediction_id__data_query_post): Download prediction results — POST variant for large filter payloads. ## attributions - [List Attributions](/api/attributions/list_attributions_projects__team_id___project_id__attributions_get): List attributions. - [Submit Attribution](/api/attributions/submit_attribution_projects__team_id___project_id__attributions_post): Submit an attribution job. - [Bulk Delete Attributions](/api/attributions/bulk_delete_attributions_projects__team_id___project_id__attributions_delete): Bulk delete attribution jobs matching the given filters. - [Submit Attribution From Job](/api/attributions/submit_attribution_from_job_projects__team_id___project_id__attributions_from_job_post): Submit an attribution job using a simulation/prediction/optimization as input. - [Submit Multiple Attributions](/api/attributions/submit_multiple_attributions_projects__team_id___project_id__attributions_multiple_post): Submit multiple attribution jobs. - [Get Attribution](/api/attributions/get_attribution_projects__team_id___project_id__attributions__attributionjob_id__get): Get an attribution. - [Update Attribution](/api/attributions/update_attribution_projects__team_id___project_id__attributions__attributionjob_id__patch): Update attribution attributes. - [Delete Attribution](/api/attributions/delete_attribution_projects__team_id___project_id__attributions__attributionjob_id__delete): Delete an attribution. - [Get Attribution Dates Min Max](/api/attributions/get_attribution_dates_min_max_projects__team_id___project_id__attributions__attributionjob_id__dates_min_max_get): Get min and max dates from attribution results. - [Get Attribution Baseline](/api/attributions/get_attribution_baseline_projects__team_id___project_id__attributions__attributionjob_id__baseline_get): Get baseline values for an attribution. - [Download Attribution](/api/attributions/download_attribution_projects__team_id___project_id__attributions__attributionjob_id__data_get): Get attribution job result data. - [Download Attribution Query](/api/attributions/download_attribution_query_projects__team_id___project_id__attributions__attributionjob_id__data_query_post): Get attribution job result data — POST variant for large filter payloads. - [Get Attribution Group Metrics](/api/attributions/get_attribution_group_metrics_projects__team_id___project_id__attributions__attributionjob_id__group_metrics_get): Get effect/share rows from AttributionGroupMetrics for a completed attribution. - [Get Attribution Variable Metrics](/api/attributions/get_attribution_variable_metrics_projects__team_id___project_id__attributions__attributionjob_id__variable_metrics_get): Get effect/share rows from AttributionVariableMetrics for a completed attribution. - [Get Attribution Totals](/api/attributions/get_attribution_totals_projects__team_id___project_id__attributions__attributionjob_id__totals_get): Get TotalEffect rows from AttributionTotals for a completed attribution. - [Get Attribution Group Roi](/api/attributions/get_attribution_group_roi_projects__team_id___project_id__attributions__attributionjob_id__group_roi_get): Get investment/ROI rows from AttributionGroupROI for a completed attribution. - [Get Attribution Variable Roi](/api/attributions/get_attribution_variable_roi_projects__team_id___project_id__attributions__attributionjob_id__variable_roi_get): Get investment/ROI rows from AttributionVariableROI for a completed attribution. ## attribution-sets - [List Attribution Sets](/api/attribution-sets/list_attribution_sets_projects__team_id___project_id__attributionset_get): List all attribution sets in the project with optional filtering. - [Create Attribution Set](/api/attribution-sets/create_attribution_set_projects__team_id___project_id__attributionset_post): Create an attribution set from attribution jobs for dashboard display. - [Bulk Delete Attribution Sets](/api/attribution-sets/bulk_delete_attribution_sets_projects__team_id___project_id__attributionset_delete): Bulk delete attribution sets matching the given filters. - [Create Attribution Set Align Dates](/api/attribution-sets/create_attribution_set_align_dates_projects__team_id___project_id__attributionset_align_dates_post): Create an attribution set with automatic date alignment to avoid overlap. - [List Attribution Set Active History](/api/attribution-sets/list_attribution_set_active_history_projects__team_id___project_id__attributionset_active_history_get): List the history of active attribution set changes for this project. - [Get Attribution Set](/api/attribution-sets/get_attribution_set_projects__team_id___project_id__attributionset__attributionset_id__get): Get detailed information about a specific attribution set. - [Update Attribution Set](/api/attribution-sets/update_attribution_set_projects__team_id___project_id__attributionset__attributionset_id__patch): Update metadata attributes of an attribution set. - [Delete Attribution Set](/api/attribution-sets/delete_attribution_set_projects__team_id___project_id__attributionset__attributionset_id__delete): Delete an attribution set. - [Get Attribution Set Dates Min Max](/api/attribution-sets/get_attribution_set_dates_min_max_projects__team_id___project_id__attributionset__attributionset_id__dates_min_max_get): Get min and max dates from attribution results within this attribution set. - [Activate Attribtuion Set](/api/attribution-sets/activate_attribtuion_set_projects__team_id___project_id__attributionset__attributionset_id__activate_patch): Set an attribution set as the active dashboard view. - [Deactivate Attribution Set](/api/attribution-sets/deactivate_attribution_set_projects__team_id___project_id__attributionset__attributionset_id__activate_delete): Deactivate the active attribution set. - [Download Attribution Set](/api/attribution-sets/download_attribution_set_projects__team_id___project_id__attributionset__attributionset_id__data_get): Download aggregated attribution results as a CSV file. - [Get Attribution Set Group Metrics](/api/attribution-sets/get_attribution_set_group_metrics_projects__team_id___project_id__attributionset__attributionset_id__group_metrics_get): Get effect/share rows from AttributionSetGroupMetrics for a completed set. - [Get Attribution Set Variable Metrics](/api/attribution-sets/get_attribution_set_variable_metrics_projects__team_id___project_id__attributionset__attributionset_id__variable_metrics_get): Get effect/share rows from AttributionSetVariableMetrics for a completed set. - [Get Attribution Set Totals](/api/attribution-sets/get_attribution_set_totals_projects__team_id___project_id__attributionset__attributionset_id__totals_get): Get TotalEffect rows from AttributionSetTotals for a completed set. - [Get Attribution Set Group Roi](/api/attribution-sets/get_attribution_set_group_roi_projects__team_id___project_id__attributionset__attributionset_id__group_roi_get): Get investment/ROI rows from AttributionSetGroupROI for a completed set. - [Get Attribution Set Variable Roi](/api/attribution-sets/get_attribution_set_variable_roi_projects__team_id___project_id__attributionset__attributionset_id__variable_roi_get): Get investment/ROI rows from AttributionSetVariableROI for a completed set. ## optimizations - [List Optimizations](/api/optimizations/list_optimizations_projects__team_id___project_id__optimizations_get): List all optimization jobs in the project with optional filtering. - [Submit Optiomization](/api/optimizations/submit_optiomization_projects__team_id___project_id__optimizations_post): Submit an optimization job to find optimal variable allocations. - [Bulk Delete Optimizations](/api/optimizations/bulk_delete_optimizations_projects__team_id___project_id__optimizations_delete): Bulk delete optimization jobs matching the given filters. - [Get Optimization](/api/optimizations/get_optimization_projects__team_id___project_id__optimizations__optimization_id__get): Get detailed information about a specific optimization job. - [Update Optimization](/api/optimizations/update_optimization_projects__team_id___project_id__optimizations__optimization_id__patch): Update metadata attributes of an optimization job. - [Delete Optimization](/api/optimizations/delete_optimization_projects__team_id___project_id__optimizations__optimization_id__delete): Delete an optimization job and its associated data. - [Get Optimization Dates Min Max](/api/optimizations/get_optimization_dates_min_max_projects__team_id___project_id__optimizations__optimization_id__dates_min_max_get): Get min and max dates from optimization result data. - [Download Optimzation](/api/optimizations/download_optimzation_projects__team_id___project_id__optimizations__optimization_id__data_get): Download optimal variable allocations as a CSV file. - [Download Optimization Query](/api/optimizations/download_optimization_query_projects__team_id___project_id__optimizations__optimization_id__data_query_post): Download optimal variable allocations — POST variant for large filter payloads. - [Simulate With Optimization Result](/api/optimizations/simulate_with_optimization_result_projects__team_id___project_id__optimizations__optimization_id__simulate_post): Create a simulation using the optimal variable allocation. ## response-curves - [List Response Curves](/api/response-curves/list_response_curves_projects__team_id___project_id__response_curve_get): List response curve jobs. - [Submit Response Curve](/api/response-curves/submit_response_curve_projects__team_id___project_id__response_curve_post): Submit a response curve job. - [Bulk Delete Response Curves](/api/response-curves/bulk_delete_response_curves_projects__team_id___project_id__response_curve_delete): Bulk delete response curve jobs matching the given filters. - [Get Response Curve](/api/response-curves/get_response_curve_projects__team_id___project_id__response_curve__curve_id__get): Get detailed response curve job. - [Update Response Curve Job](/api/response-curves/update_response_curve_job_projects__team_id___project_id__response_curve__curve_id__patch): Update a response curve job. - [Delete Response Curve](/api/response-curves/delete_response_curve_projects__team_id___project_id__response_curve__curve_id__delete): Delete a response curve job. - [Get Response Curve Dates Min Max](/api/response-curves/get_response_curve_dates_min_max_projects__team_id___project_id__response_curve__curve_id__dates_min_max_get): Get min and max dates from temporal curve result data. - [Download Response Curve](/api/response-curves/download_response_curve_projects__team_id___project_id__response_curve__curve_id__data_get): Get response curve result as CSV file. - [Download Response Curve Query](/api/response-curves/download_response_curve_query_projects__team_id___project_id__response_curve__curve_id__data_query_post): Get response curve results — POST variant for large filter payloads. - [Get Temporal Csv Output](/api/response-curves/get_temporal_csv_output_projects__team_id___project_id__response_curve__curve_id__temporal_get): Get response curve temporal result as CSV file. - [Get Temporal Csv Output Query](/api/response-curves/get_temporal_csv_output_query_projects__team_id___project_id__response_curve__curve_id__temporal_query_post): Get response curve temporal results — POST variant for large filter payloads. ## prior-posterior - [List Prior Vs Posterior](/api/prior-posterior/list_prior_vs_posterior_projects__team_id___project_id__prior_posterior_get): List prior vs posterior jobs. - [Submit Prior Vs Posterior](/api/prior-posterior/submit_prior_vs_posterior_projects__team_id___project_id__prior_posterior_post): Submit a prior posterior job. - [Bulk Delete Prior Posterior](/api/prior-posterior/bulk_delete_prior_posterior_projects__team_id___project_id__prior_posterior_delete): Bulk delete prior vs posterior jobs matching the given filters. - [Get Prior Vs Poterior](/api/prior-posterior/get_prior_vs_poterior_projects__team_id___project_id__prior_posterior__prior_posterior_id__get): Get detailed prior vs posterior job. - [Update Prior Posterior Job](/api/prior-posterior/update_prior_posterior_job_projects__team_id___project_id__prior_posterior__prior_posterior_id__patch): Update a prior posterior job. - [Delete Prior Posterior](/api/prior-posterior/delete_prior_posterior_projects__team_id___project_id__prior_posterior__prior_posterior_id__delete): Delete a prior posterior job. - [Download Prior Posterior](/api/prior-posterior/download_prior_posterior_projects__team_id___project_id__prior_posterior__prior_posterior_id__data_get): Get prior posterior job result as CSV file. - [Download Prior Posterior Query](/api/prior-posterior/download_prior_posterior_query_projects__team_id___project_id__prior_posterior__prior_posterior_id__data_query_post): Get prior posterior results — POST variant for large filter payloads. ## excel-jobs - [List Excel Export Tasks](/api/excel-jobs/list_excel_export_tasks_projects__team_id___project_id__excel_get): List Excel jobs. - [Submit Excel Export Task](/api/excel-jobs/submit_excel_export_task_projects__team_id___project_id__excel_post): Submit an Excel export task. - [Bulk Delete Excel Jobs](/api/excel-jobs/bulk_delete_excel_jobs_projects__team_id___project_id__excel_delete): Bulk delete Excel jobs matching the given filters. - [Delete Excel Export Task](/api/excel-jobs/delete_excel_export_task_projects__team_id___project_id__excel__excel_job_id__delete): Delete an Excel job. - [Download Excel Export](/api/excel-jobs/download_excel_export_projects__team_id___project_id__excel__excel_job_id__output_get): Get Excel job output. ## notifications - [Get Ntfy Token](/api/notifications/get_ntfy_token_notification__team_id__ntfy_token_get): Get a ntfy access token for the team. ## templates - [List Templates](/api/templates/list_templates_templates__team_id__get): Get list of templates. - [Create Template](/api/templates/create_template_templates__team_id__post): Create a template. - [Get Template](/api/templates/get_template_templates__team_id___template_id__get): Get a template. - [Update Template](/api/templates/update_template_templates__team_id___template_id__patch): Patch template attributes. - [Delete Template](/api/templates/delete_template_templates__team_id___template_id__delete): Delete a template. ## internal - [Get Bucket Config](/api/internal/get_bucket_config_internal_bucket_config_get): Resolve S3 bucket config for drun and cache it in Redis. ## teams - [List ](/api/teams/list__teams_get): List or search for multiple teams. - [Get](/api/teams/get_teams__team_id__get): Get detailed information on a single team. - [Update](/api/teams/update_teams__team_id__patch): Update a team. - [Delete](/api/teams/delete_teams__team_id__delete): Delete a team. - [List Members](/api/teams/list_members_teams__team_id__member_get): List members of a team with additional details from user service. - [Add Member](/api/teams/add_member_teams__team_id__member_post): Add a member to a team. - [Update Member Role](/api/teams/update_member_role_teams__team_id__member_patch): Assign a new role to a team member. - [Remove Member](/api/teams/remove_member_teams__team_id__member_delete): Remove a member from a team. - [Leave Team](/api/teams/leave_team_teams__team_id__leave_delete): Leave your currently active team. - [Get Roles](/api/teams/get_roles_teams__team_id__roles_get): Get all available roles and their permissions. ## manage-invitations - [List Invitations](/api/manage-invitations/list_invitations_teams__team_id__invitations_get): List all team invitations. - [Update Invitation](/api/manage-invitations/update_invitation_teams__team_id__invitations__invitation_id__patch): Update a team invitation's role. - [Delete Invitation](/api/manage-invitations/delete_invitation_teams__team_id__invitations__invitation_id__delete): Delete a team invitation. ## invitations - [Get Invitation](/api/invitations/get_invitation_invitations__code__get): Get a team invitation. - [Accept Invitation](/api/invitations/accept_invitation_invitations__code__post): Accept a team invitation. - [Decline Invitation](/api/invitations/decline_invitation_invitations__code__delete): Decline a team invitation. - [Get Invitations](/api/invitations/get_invitations_invitations_get): Get all team invitations for a user. ## health - [Health Check](/api/health/health_check_health_get): Basic liveness check. - [Readiness Check](/api/health/readiness_check_ready_get): Readiness check with dependency verification. ## access-token - [Get User Tokens](/api/access-token/get_user_tokens_access_tokens_get): Get user tokens. - [Create User Token](/api/access-token/create_user_token_access_tokens_post): Create user token. - [Revoke User Token](/api/access-token/revoke_user_token_access_tokens__token_id__delete): Revoke user token. ## user - [Get Current User](/api/user/get_current_user_current_get): Get current user. - [Update](/api/user/update_current_patch): Update current user. - [Delete](/api/user/delete_current_delete): Delete current user.