Auxia
Search
K
Comment on page

Log Treatment Interactions

This API enables your team to monitor how your users are engaging with the touchpoints you distribute through Auxia.

API Definition

post
https://apis.auxia.io/v1/LogTreatmentInteraction

Raw request body

{
"project_id": "1250",
"treatment_tracking_id": "6_690e24d8-16a6-4518-bf37-09a8f0120dfb",
"interaction_type": "CLICKED",
"interaction_time_micros":1667829258250000
}

Example Curl

curl --location --request POST 'https://apis.auxia.io/v1/LogTreatmentInteraction' \
--header 'Content-Type: application/json, x-api-key: ****************' \
--data-raw '{
"project_id": "1250",
"treatment_tracking_id": "6_690e24d8-16a6-4518-bf37-09a8f0120dfb",
"interaction_type": "CLICKED",
"interaction_time_micros":1667829258250000
}'

Response

< content-type: application/json
<
{ }

Schema reference

Request

This API may be called multiple times for each treatment_tracking_id for different interactions or recurring interactions.
Name
Data Type
Required?
Text
project_id
String
Required
For a given customer's project, this should always be the same.
treatment_tracking_id
String
Required
A unique ID that is obtained for each treatment returned by the getTreatments API. This can be passed back in this API to complete the feedback loop.
interaction_type
String
Required
This specifies the type of interaction. Supported values include:
  • VIEWED
  • CLICKED
  • SNOOZED
  • DISMISSED
  • CTA_COMPLETED
interaction_time_micros
String
Required
This indicates the time at which the interaction occurred. Please ensure the timestamp matches the timestamp recorded by your analytics events (e.g. Amplitude, Firebase, etc). This represents the number of microseconds of UTC time after Unix epoch.

Response

An empty response indicates that the RPC was completed successfully