Making your first call
How to make your first call with Auxia
Last updated
How to make your first call with Auxia
Last updated
Visit the guide here (Creating your first treatment) to set up a sample treatment for testing.
Go to the console, click on the API Integration tab, and click "Show API Key" to get the API Key.
Once you have the API key, fire the curl request below through the UI or from your terminal.
This request has the following parameters:
projectId
string
For a given customer's project, this should always be the same.
userId
string
This is the Unique ID for every user.
surfaces
json
Surface
surface
string
Client configured parameter to request treatments for a particular UI component, screen (home screen), or use case (coupon). A typical example of surface is "HOME_SCREEN" or "PURCHASE_SCREEN".
maximumTreatmentCount
int64
Maximum number of treatments that should be returned to the client for the given surface. If no value is set, this defaults to 1.
minimumTreatmentCount
int64
Minimum number of treatments that should be returned to the client for a given surface. If this field is set, the response is guaranteed to have either 0 or greater than equal to the value of minimumTreatmentCount number of treatments. If no value is set, it defaults to 0.
See below for a sample response:
Refer to the