# Auxia Docs

> Documentation for the Auxia platform

## Auxia Docs

- [Welcome!](https://docs.auxia.io/index.md)

### Product Concepts

- [Product Concepts](https://docs.auxia.io/concepts.md)
- [Goals](https://docs.auxia.io/concepts/goals.md)
- [Journeys](https://docs.auxia.io/concepts/journeys.md)
- [Treatments](https://docs.auxia.io/concepts/treatments.md)
- [Target Actions](https://docs.auxia.io/concepts/target-actions.md)
- [Guardrails](https://docs.auxia.io/concepts/guardrails.md)
- [Treatment Types](https://docs.auxia.io/concepts/treatment-types.md)
- [Surfaces](https://docs.auxia.io/concepts/surfaces.md)
- [Destinations](https://docs.auxia.io/concepts/destinations.md)
- [Data Fields](https://docs.auxia.io/concepts/data-fields.md)
- [Analytics](https://docs.auxia.io/concepts/analytics.md)
- [Agentic Capabilities](https://docs.auxia.io/concepts/ai-insights.md)

### Documentation

#### Integration Quick Start

- [Integration Quick Start](https://docs.auxia.io/getting-started.md)
- [Step 1: Ingesting your data](https://docs.auxia.io/getting-started/step-1-ingesting-your-data.md)
- [Step 2: Integrating Auxia into your product](https://docs.auxia.io/getting-started/step-2-integrating-auxia-into-your-product.md): How to integrate Auxia into your product
- [Step 3: Defining your goals](https://docs.auxia.io/getting-started/step-3-defining-your-model-objective.md)
- [Step 4: Creating your first treatment](https://docs.auxia.io/getting-started/step-4-creating-your-first-treatment.md)
- [Step 5: Measuring Success](https://docs.auxia.io/getting-started/step-5-measuring-success.md)

#### Data Ingestion

##### Overview

- [Overview](https://docs.auxia.io/data-ingestion/overview.md): Understand how to connect your data to Auxia
- [Getting Started](https://docs.auxia.io/data-ingestion/overview/getting-started.md): Exploring datasets and mapping your schema
- [User Event Data](https://docs.auxia.io/data-ingestion/overview/event-data.md)
- [User attributes](https://docs.auxia.io/data-ingestion/overview/attributes-data.md): Understanding user attribute data structure

##### Data Connections

- [Data Connections](https://docs.auxia.io/data-ingestion/data-connections.md): How to ingest your data into the Auxia platform
- [Google BigQuery](https://docs.auxia.io/data-ingestion/data-connections/google-bigquery.md): Setting up a data connection via Google BigQuery
- [Firebase Event Tracking and BigQuery Integration](https://docs.auxia.io/data-ingestion/data-connections/firebase-event-tracking-with-gcp-bigquery-integration.md)
- [Amazon S3](https://docs.auxia.io/data-ingestion/data-connections/amazon-s3.md): Setting up a data connection via Amazon S3
- [Amazon Kinesis](https://docs.auxia.io/data-ingestion/data-connections/amazon-kinesis.md): Streaming event ingestion from an Amazon Kinesis data stream

###### Snowflake

- [Snowflake](https://docs.auxia.io/data-ingestion/data-connections/snowflake.md): Connect Auxia to your Snowflake data. Choose the method that fits your setup.
- [Snowflake (Direct Connection)](https://docs.auxia.io/data-ingestion/data-connections/snowflake/direct-connection.md): Auxia reads your Snowflake tables in place via a read-only role you grant
- [Snowflake (GCS Export)](https://docs.auxia.io/data-ingestion/data-connections/snowflake/gcs-export.md): Setting up data ingestion from Snowflake via GCS export
- [Snowflake (Secure Data Sharing)](https://docs.auxia.io/data-ingestion/data-connections/snowflake/data-sharing.md): Setting up a data connection via Snowflake Secure Data Sharing

###### GCP Pub/Sub

- [GCP PubSub](https://docs.auxia.io/data-ingestion/data-connections/gcp-pubsub.md): Setting up data ingestion via Google Cloud PubSub
- [Events and User Attributes ingestion via Pub/Sub](https://docs.auxia.io/data-ingestion/data-connections/gcp-pubsub/events-and-users-attributes-ingestion-via-pubsub.md): Guide for publishing user events and attributes using Pub/Sub

###### Amplitude

- [Amplitude](https://docs.auxia.io/data-ingestion/data-connections/amplitude.md)
- [Batch with Export API](https://docs.auxia.io/data-ingestion/data-connections/amplitude/amplitude-batch-with-export-API.md)
- [Streaming with Google Pub/Sub](https://docs.auxia.io/data-ingestion/data-connections/amplitude/amplitude-streaming-via-google-pubsub.md)

#### Deploying Auxia

##### Deploying with Auxia API

- [Deploying with Auxia's API](https://docs.auxia.io/deploying-auxia/deploying-with-auxia-api.md): Steps to implement Auxia's APIs in your product
- [Making Your First Call](https://docs.auxia.io/deploying-auxia/deploying-with-auxia-api/making-your-first-call.md): How to make your first call with Auxia
- [Surfaces and Types](https://docs.auxia.io/deploying-auxia/deploying-with-auxia-api/surfaces-and-types.md): Understanding surfaces and treatment types in Auxia
- [Contextual Attributes](https://docs.auxia.io/deploying-auxia/deploying-with-auxia-api/contextual-attributes.md): Using real-time data for better treatment distribution

##### Delivery Integrations

- [Delivery Integrations](https://docs.auxia.io/deploying-auxia/delivery-integrations.md): How to connect to major message delivery platforms
- [Braze](https://docs.auxia.io/deploying-auxia/delivery-integrations/braze.md): How to connect your Braze account with Auxia

###### Firebase Push Notifications

- [Overview](https://docs.auxia.io/deploying-auxia/delivery-integrations/firebase-push-notifications-integration-manual/overview.md): Firebase Push Notifications Integration with Auxia Systems
- [Integrate Firebase on the client application](https://docs.auxia.io/deploying-auxia/delivery-integrations/firebase-push-notifications-integration-manual/integrate-firebase-on-the-client-application.md): Set up your client application to receive push notifications
- [Enable Auxia to Send Push Notifications](https://docs.auxia.io/deploying-auxia/delivery-integrations/firebase-push-notifications-integration-manual/enable-auxia-to-send-notification.md): Configure Auxia to send push notifications through Firebase
- [Enable Auxia to collect notification events](https://docs.auxia.io/deploying-auxia/delivery-integrations/firebase-push-notifications-integration-manual/enable-auxia-to-collect-notification-events.md): Configure Auxia to track and analyze push notification performance
- [Sample Push Notification Script](https://docs.auxia.io/deploying-auxia/delivery-integrations/firebase-push-notifications-integration-manual/sample-push-notifications-script.md): Example script for implementing Firebase push notifications

###### Sample Flutter Setup

- [Sample Flutter Set up](https://docs.auxia.io/deploying-auxia/delivery-integrations/firebase-push-notifications-integration-manual/sample-flutter-set-up.md): This section contains helpful links to set up a sample Flutter Android application to integrate push notifications and corresponding notification events.
- [Sample Flutter Client Implementation](https://docs.auxia.io/deploying-auxia/delivery-integrations/firebase-push-notifications-integration-manual/sample-flutter-set-up/sample-flutter-client-implementation.md)

#### API Reference

- [Get Treatments](https://docs.auxia.io/api-reference/get-treatments.md): The Get Treatments API fetches all of the details that are needed for rendering the treatments in your app or other surface.
- [Log Events](https://docs.auxia.io/api-reference/log-events.md): The Log Events API allows you to send user events and properties to Auxia for real-time processing.
- [Log Treatment Interactions](https://docs.auxia.io/api-reference/log-treatment-interactions.md): This API enables your team to monitor how your users are engaging with the touchpoints you distribute through Auxia.

##### SDK

- [JavaScript SDK Integration Guide](https://docs.auxia.io/api-reference/sdk/javascript-sdk.md): Integrate the Auxia JavaScript SDK to deliver personalized treatments to your web application users.

##### Treatment Management

- [Treatment Management](https://docs.auxia.io/api-reference/treatment-management.md)
- [Insert/Update Treatment](https://docs.auxia.io/api-reference/treatment-management/insert-update-treatment.md): APIs for inserting and updating treatments via API.
- [Insert/Update Treatment Type](https://docs.auxia.io/api-reference/treatment-management/insert-update-treatment-type.md): APIs for inserting and updating treatment types via API.
- [Get Treatment](https://docs.auxia.io/api-reference/treatment-management/get-treatment.md): API to fetch the details of a single treatment by ID
- [Get All Treatments](https://docs.auxia.io/api-reference/treatment-management/get-all-treatments.md): API for getting all treatments via API.
- [Get DataFields](https://docs.auxia.io/api-reference/treatment-management/get-datafields.md): API for getting DataFields via API.
- [Insert DataField](https://docs.auxia.io/api-reference/treatment-management/insert-data-field.md): API for registering a DataField via API.
- [Insert Surface](https://docs.auxia.io/api-reference/treatment-management/insert-surface.md): API for registering a Surface via API.

#### Bulk Upload

- [Bulk Upload](https://docs.auxia.io/bulk-upload.md)
- [Generate CSV Template](https://docs.auxia.io/bulk-upload/generate-template.md)
- [CSV Field Reference](https://docs.auxia.io/bulk-upload/csv-field-reference.md)
- [Upload and Validate](https://docs.auxia.io/bulk-upload/upload-and-validate.md)
- [Bulk Upload History](https://docs.auxia.io/bulk-upload/bulk-upload-history.md)

### User Guides

#### Quick Start Guide

- [Introduction to Auxia Console](https://docs.auxia.io/guides/quick-start/introduction.md)
- [First-Time Setup Checklist](https://docs.auxia.io/guides/quick-start/first-time-setup.md)
- [Understanding Goals](https://docs.auxia.io/guides/quick-start/understanding-goals.md)
- [Creating Your First Journey](https://docs.auxia.io/guides/quick-start/creating-first-journey.md)
- [Creating Your First Treatment](https://docs.auxia.io/guides/quick-start/creating-first-treatment.md)
- [QA Testing](https://docs.auxia.io/guides/quick-start/qa-testing.md)
- [Understanding Analytics](https://docs.auxia.io/guides/quick-start/understanding-analytics.md)
- [Using Agent and AI Insights](https://docs.auxia.io/guides/quick-start/using-ai-insights.md)
- [Quick Reference](https://docs.auxia.io/guides/quick-start/quick-reference.md)

##### Appendices

- [Glossary](https://docs.auxia.io/guides/quick-start/appendices/glossary.md)

#### Console Reference

- [Introduction](https://docs.auxia.io/guides/comprehensive/introduction.md)
- [Section 2: Home Dashboard](https://docs.auxia.io/guides/comprehensive/home-dashboard.md)
- [Managing Goals](https://docs.auxia.io/guides/comprehensive/goals.md)
- [Managing Journeys](https://docs.auxia.io/guides/comprehensive/journeys.md)
- [Managing Treatments](https://docs.auxia.io/guides/comprehensive/treatments.md)
- [Analytics](https://docs.auxia.io/guides/comprehensive/analytics.md)
- [Agent and AI Insights](https://docs.auxia.io/guides/comprehensive/ai-insights.md)
- [Section 8: QA & Testing](https://docs.auxia.io/guides/comprehensive/qa-testing.md)
- [Configuration](https://docs.auxia.io/guides/comprehensive/configuration.md)
- [Section 10: Admin (Users & Roles)](https://docs.auxia.io/guides/comprehensive/admin.md)

##### SSO Setup

- [Single Sign-On (SSO) Setup](https://docs.auxia.io/guides/comprehensive/sso.md)
- [Setting Up SSO with Microsoft Entra ID](https://docs.auxia.io/guides/comprehensive/sso/microsoft-entra-id.md)
- [Setting Up SSO with Okta](https://docs.auxia.io/guides/comprehensive/sso/okta.md)
- [Setting Up SSO with Auth0](https://docs.auxia.io/guides/comprehensive/sso/auth0.md)

##### Appendices

- [Appendix A: Glossary](https://docs.auxia.io/guides/comprehensive/appendices/glossary.md)
- [Appendix B: Permissions Reference](https://docs.auxia.io/guides/comprehensive/appendices/permissions-reference.md)
- [Appendix C: Troubleshooting & FAQ](https://docs.auxia.io/guides/comprehensive/appendices/troubleshooting-faq.md)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Japanese (93 pages)](https://docs.auxia.io/_llms/ja.md): Documentation for Japanese.