Auxia
  • Welcome!
  • Quick Start
    • Getting Started
      • Step 1: Ingesting your data
      • Step 2: Integrating Auxia into your product
      • Step 3: Defining your model objective
      • Step 4: Creating your first treatment
      • Step 5: Measuring success
        • Interactions
        • Engagement
  • Data Ingestion
    • Overview
      • User event data
      • User attributes
    • Data Connections
      • Google BigQuery
      • Amazon S3
      • Amplitude
        • Batch with Export API
        • Streaming with Google Pub/Sub
  • Deploying Auxia
    • Deploying with Auxia's API
      • Making your first call
      • Tracking interactions
      • Surfaces and types
      • Contextual attributes for real-time distribution
    • Delivery Integrations
      • Braze
  • API Reference
    • Get Treatments
    • Log Treatment Interactions
  • Treatment Management
Powered by GitBook
On this page
  1. Deploying Auxia
  2. Deploying with Auxia's API

Surfaces and types

PreviousTracking interactionsNextContextual attributes for real-time distribution

Last updated 7 months ago

A Treatment Type is a format/template for a type of treatment which can be rendered on the client application (mobile or web).

An example of a treatment type is an overlay, which can be rendered on multiple pages across the client application. Let’s take an example of a treatment type below:

In this example, we have defined a treatment type for an overlay use case, where we want to render a title, along with a body, background image, and a button with a text and link to another page.

Note that this treatment type can be rendered across multiple components and pages.

In the Auxia system, we call these different components and pages a 'Surface'. A single Treatment Type can be associated with multiple surfaces, allowing you to create a single treatment that can then be rendered across different parts of the app.

The relationship between the 'Surface' (left hand side) and 'Treatment Type' is represented below.

As a general rule of thumb, it’s advised to keep 'Surface' as specific as possible and a 'Treatment Type' as general as possible, so that your team can leverage Auxia's platform to render generalized templates (such as banner or overlay) across different parts of the application without creating duplicate treatments. Additionally, you will have the ability to measure the performance of the same treatment (and treatment template) across different components of the application.

Page cover image