# Allyy Documentation Portal

- [Introduction](https://docs.allyy.io/introduction.md): Welcome to the Allyy.io documentation portal
- [How Allyy works](https://docs.allyy.io/get-started/how-allyy-works.md): The end-to-end journey from raw supporter data to optimised decisions
- [Key concepts & glossary](https://docs.allyy.io/get-started/concepts.md): The vocabulary you need to work with Allyy
- [Quickstart](https://docs.allyy.io/get-started/quickstart.md): From a fresh account to your first prediction
- [The Allyy data model](https://docs.allyy.io/data/data-model.md): The handful of entities every data source is mapped onto
- [Preparing your data](https://docs.allyy.io/data/data-requirements.md): The data Allyy uses, in fundraising terms — and how to share it
- [Data](https://docs.allyy.io/processes/data.md): Documentation for setting up and managing data sources
- [Data mapping](https://docs.allyy.io/processes/data_mapping.md): Documentation for mapping data towards Allyys data structure
- [What Allyy can predict](https://docs.allyy.io/models/what-allyy-can-predict.md): The catalogue of models, grouped by the fundraising question they answer
- [DM propensity](https://docs.allyy.io/models/dm-propensity.md): Will this supporter respond to a mailing?
- [TM reachability](https://docs.allyy.io/models/tm-reachability.md): Will we actually reach this person by phone?
- [TM conversion](https://docs.allyy.io/models/tm-conversion.md): Once we reach them, will they accept the offer?
- [DM expected amount](https://docs.allyy.io/models/dm-expected-amount.md): How much will this mailing raise from this supporter?
- [Active donor](https://docs.allyy.io/models/active-donor.md): Will a currently-active supporter give again in the year ahead?
- [Middle donor](https://docs.allyy.io/models/middle-donor.md): Will this supporter grow into a mid-value donor?
- [Reactivating donor](https://docs.allyy.io/models/reactivating-donor.md): Will a lapsed donor come back if we ask?
- [Subscription acquisition](https://docs.allyy.io/models/subscription-acquisition.md): Will a one-off donor start giving regularly?
- [Subscription churn](https://docs.allyy.io/models/subscription-churn.md): Will a regular giver cancel their direct debit soon?
- [Create & train a model](https://docs.allyy.io/processes/model.md): How to train a model on your data to answer a fundraising question
- [Generating predictions](https://docs.allyy.io/predictions/generating-predictions.md): Apply a trained model to a population to produce scores
- [From predictions to decisions](https://docs.allyy.io/predictions/decisions.md): How Allyy turns model scores into an optimised, ranked action list
- [Exporting decisions](https://docs.allyy.io/predictions/exporting.md): Get an optimised contact list out of Allyy and into your tools
- [Model evaluation dashboards](https://docs.allyy.io/dashboards-evaluation/overview.md): Assess how your models perform across different business objectives, prediction types, and campaigns.
- [Classification model](https://docs.allyy.io/dashboards-evaluation/classification-model.md)
- [Regression model](https://docs.allyy.io/dashboards-evaluation/regression-model.md)
- [Classification SHAP](https://docs.allyy.io/dashboards-evaluation/classification-shap.md): Model Explainability (SHAP Insights) (Classification Models)
- [Regression SHAP](https://docs.allyy.io/dashboards-evaluation/regression-shap.md): Model Explainability (SHAP Insights) (Regression Model)
- [Analytics dashboards](https://docs.allyy.io/analytics/overview.md): A descriptive view of your supporter base — where income comes from, who your donors are, and how to keep them
- [Data health](https://docs.allyy.io/analytics/data-health.md): Is the file healthy, and can I trust the data behind these numbers?
- [Where income comes from](https://docs.allyy.io/analytics/income.md): What drives your income — concentration, campaigns, seasonality, gift sizes, and what moved the total
- [My donor base](https://docs.allyy.io/analytics/donor-base.md): Who your donors are, how they move between segments, and whether you are over-contacting them
- [Growing & keeping value](https://docs.allyy.io/analytics/value.md): Grow regular giving, move donors up in value, win back lapsed donors, and understand long-term value
- [Workflows](https://docs.allyy.io/automation/workflows.md): Automate the data → model → prediction → export loop on a schedule
- [Monitoring Dashboard](https://docs.allyy.io/processes/monitoring_dashboard.md): Documentation for Monitoring Dashboards and Logs
- [Integrations overview](https://docs.allyy.io/integrations/overview.md): How data gets into Allyy and how decisions get out
- [Allyy Salesforce Connector](https://docs.allyy.io/integrations/salesforce.md): Allyy Salesforce Connector application installation guide
- [Content recommendations in CMS](https://docs.allyy.io/integrations/content_recommendation.md): Content recommendations: Integration with the Client’s CMS
- [Introduction](https://docs.allyy.io/api-reference/introduction.md): Preconditions to start working with Allyy API
- [Get authentication token](https://docs.allyy.io/api-reference/get_token.md)
- [Get datasets](https://docs.allyy.io/api-reference/data/get_datasets.md)
- [Get datasources](https://docs.allyy.io/api-reference/data/get_datasources.md)
- [Get datasource](https://docs.allyy.io/api-reference/data/get_datasource.md)
- [Get datasource uploads](https://docs.allyy.io/api-reference/data/get_datasource_uploads.md)
- [Start ActiveCampaign synchronization](https://docs.allyy.io/api-reference/data/post_activecampaign_synchronization.md)
- [Start Agillic synchronization](https://docs.allyy.io/api-reference/data/post_agillic_synchronization.md)
- [Start Big Query synchronization](https://docs.allyy.io/api-reference/data/post_bigquery_synchronization.md)
- [Upload CSV file](https://docs.allyy.io/api-reference/data/post_csv_upload.md)
- [Start Google Analytics 4 synchronization](https://docs.allyy.io/api-reference/data/post_ga4_synchronization.md)
- [Start Google Cloud Storage synchronization](https://docs.allyy.io/api-reference/data/post_gcs_synchronization.md)
- [Upload JSON file](https://docs.allyy.io/api-reference/data/post_json_upload.md)
- [Start MSSQL synchronization](https://docs.allyy.io/api-reference/data/post_mssql_synchronization.md)
- [Start Naviga synchronization](https://docs.allyy.io/api-reference/data/post_naviga_synchronization.md)
- [Start SFTP synchronization](https://docs.allyy.io/api-reference/data/post_sftp_synchronization.md)
- [Get models](https://docs.allyy.io/api-reference/model/get_models.md)
- [Get model](https://docs.allyy.io/api-reference/model/get_model.md)
- [Get model trainings](https://docs.allyy.io/api-reference/model/get_model_trainings.md)
- [Start model training](https://docs.allyy.io/api-reference/model/post_model_training.md)
- [Get model training statistics: feature impact](https://docs.allyy.io/api-reference/model/get_model_training_statistics_feature_impact.md)
- [Get model training statistics: beeswarm](https://docs.allyy.io/api-reference/model/get_model_training_statistics_beeswarm.md)
- [Get model training statistics: feature dependence](https://docs.allyy.io/api-reference/model/get_model_training_statistics_feature_dependence.md)
- [Get model training statistics: feature dependence with secondary feature](https://docs.allyy.io/api-reference/model/get_model_training_statistics_feature_dependence_secondary_feature.md)
- [Get model training statistics: waterfall data](https://docs.allyy.io/api-reference/model/get_model_training_statistics_waterfall.md)
- [Get predictions](https://docs.allyy.io/api-reference/prediction/get_predictions.md)
- [Get prediction](https://docs.allyy.io/api-reference/prediction/get_prediction.md)
- [Get prediction executions](https://docs.allyy.io/api-reference/prediction/get_prediction_executions.md)
- [Start prediction execution](https://docs.allyy.io/api-reference/prediction/post_prediction_execution.md)
- [Get decisions](https://docs.allyy.io/api-reference/decision/get_decisions.md)
- [Get decision](https://docs.allyy.io/api-reference/decision/get_decision.md)
- [Get decision runs](https://docs.allyy.io/api-reference/decision/get_decision_runs.md)
- [Start decision run](https://docs.allyy.io/api-reference/decision/post_decision_run.md)
- [Get export configurations](https://docs.allyy.io/api-reference/export/get_export_configurations.md)
- [Get export configuration](https://docs.allyy.io/api-reference/export/get_export_configuration.md): Returns extended export configuration details including last synchronization info.
- [Get export synchronizations](https://docs.allyy.io/api-reference/export/get_export_synchronizations.md)
- [Start export synchronization](https://docs.allyy.io/api-reference/export/post_export_synchronization.md)
- [Download exported CSV](https://docs.allyy.io/api-reference/export/get_export_synchronization_download_csv.md)
- [Get workflows](https://docs.allyy.io/api-reference/workflow/get_workflows.md)
- [Get workflow](https://docs.allyy.io/api-reference/workflow/get_workflow.md)
- [Get workflow executions](https://docs.allyy.io/api-reference/workflow/get_workflow_executions.md)
- [Get workflow execution](https://docs.allyy.io/api-reference/workflow/get_workflow_execution.md)
- [Start workflow execution](https://docs.allyy.io/api-reference/workflow/post_workflow_execution.md)

## OpenAPI Specs

- [data](/api-reference/data/data.json)
- [decision](/api-reference/decision/decision.json)
- [export](/api-reference/export/export.json)
- [model_training](/api-reference/model/model_training.json)
- [model](/api-reference/model/model.json)
- [prediction_execution](/api-reference/prediction/prediction_execution.json)
- [prediction](/api-reference/prediction/prediction.json)
- [workflow](/api-reference/workflow/workflow.json)

## Optional

- [Website](https://allyy.io)
- [Application](https://app.allyy.io)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.