Analytics Events¶

This document describes the analytics events that can be tracked within the Aiuta SDK. These events are triggered in response to user actions or state changes and can be used to track user interactions or system behaviors in your analytics system.

Event Types¶

Type	Parameters	Description
`configure`	`*`	SDK was configured with a features set
`session`	`flow`	Start of a new session, SDK about to present it's UI The page event is expected to be the following
`page`	`pageId` `productIds`	Navigation to a specific page in the SDK UI
`onboarding`	`event` `pageId` `productIds`	Interactions during the onboarding process, including viewing informational screens and providing necessary consents for data processing
`picker`	`event` `pageId` `productIds`	Interactions with the image selection interface, including camera access, gallery selection, and predefined model selection
`tryOn`	`event` `pageId` `productIds`	Virtual try-on operations reports, including photo upload, processing status, and completion or error states
`results`	`event` `pageId` `productIds`	Interactions with the generated try-on results, including sharing, saving to wishlist, adding to cart, or requesting new generations
`feedback`	`event` `pageId` `productIds`	Feedback on the generated results, including positive ratings and detailed negative feedback with optional comments
`history`	`event` `pageId` `productIds`	Interactions with previously generated results and managing saved generations
`share`	`event` `pageId` `productIds`	Events related to the user's desire to share/save generated images
`exit`	`pageId` `productIds`	Exit from the SDK on a specific page, indicating the final point in the user's journey

Identifiers¶

Identifiers to track navigation pages, products, and 3^rd party apps in the Aiuta SDK.

Page¶

Page	Description
`welcome`	Optional Welcome Screen that introduces users to the SDK functionality and provides an entry point to start the try-on process
`howItWorks`	Informational screen explaining the virtual try-on process, including samples of expected outcomes
`bestResults`	Guide screen showing best practices for achieving optimal try-on results with example images and tips
`consent`	Screen for obtaining user consent for data processing and privacy policy acceptance in standalone mode
`imagePicker`	Interface for selecting or capturing images, including camera access, gallery browsing, uploads history, and predefined model selection
`loading`	Transition screen displayed during image processing and virtual try-on generation
`results`	Screen displaying generated try-on results with options to share, save, or request new generations
`history`	Screen showing previously generated try-on results with options to view, share, or manage saved generations

Products¶

This is a list of product identifiers in the context of the current try-on session or other SDK interaction. It can be empty, for example, when opening a separate screen to view the user's generation history, where there is no try-on context. In the case of a single try-on, the list will contain one identifier. Accordingly, when using multi-try-on, the list will contain identifiers of all products from the outfit.

App¶

A string representing 3^rd party app/package/bundle id that was used to receive data from the SDK directly or through system APIs.

Specific Events¶

Types, except for page, exit, configure and session, contain an event parameter that indicates which specific event occurred in that type.

Compatibility

In widely used analytics systems, events usually have names and parameters. For structure, we wanted to group events into more general types and detail them according to specific events within the group. You can consider this as a subtype, or combine the type and event into a single event name.

Onboarding¶

Event	Parameters	Description
`welcomeStartClicked`		Initial interaction with the Welcome Screen, indicating user's intent to begin the try-on process
`onboardingFinished`		Completion of all onboarding steps
`consentsGiven`	`consentIds`	Explicit acceptance of required consents, including data processing and privacy policy agreements

Picker¶

Event	Description
	Camera
`cameraOpened`	Activation of the device camera for capturing new photos for the try-on process
`newPhotoTaken`	Successful capture of a new photo using the device camera
	System Photos
`photoGalleryOpened`	Access to the device's photo gallery for selecting existing images
`galleryPhotoSelected`	Selection of an existing photo from the device's gallery for try-on
	Uploads history
`uploadsHistoryOpened`	Access to previously uploaded photos within the SDK's history
`uploadedPhotoSelected`	Selection of a previously uploaded photo from the SDK's history
`uploadedPhotoDeleted`	Removal of a previously uploaded photo from the SDK's history
	Predefined models
`predefinedModelsOpened`	Access to the list of predefined model images available for try-on
`predefinedModelSelected`	Selection of a predefined model image for the try-on process

Try-On¶

Event	Parameters	Description
`initiated`		Start processing photo
`photoUploaded`		Successful upload of a selected or captured photo for processing
`tryOnStarted`		Initiation of the virtual try-on process with the selected image
`tryOnFinished`	`uploadDuration` `tryOnDuration` `downloadDuration` `totalDuration` ¹	Successful completion of the virtual try-on process with generated results `Duration` of each step and the entire process in seconds (floating-point)
`tryOnAborted`	`abortReason`	Cancellation of the try-on process before completion
`tryOnError`	`errorType` `errorMessage`	Occurrence of an error during the try-on process, requiring user attention. `errorMessage` contains information for developers and is not for users

Results¶

Event	Description
`productAddToWishlist`	Adding of a product from the try-on results to the user's wishlist
`productAddToCart`	Adding of a product from the try-on results to the shopping cart
`pickOtherPhoto`	Request to start a new try-on process with a different photo

Feedback¶

Event	Parameters	Description
`positive`		The user left positive feedback on try-on results with no specific issues reported
`negative`	`option` `text`	The user report of issues with try-on results, including specific problem category and optional detailed feedback

History¶

Event	Description
`generatedImageDeleted`	Removal of a previously generated try-on result from the history

Event	Parameters	Description
`initiated`		The user clicked the share button a system dialog will be displayed
`succeeded`	`targetId`	The images were successfully shared to the 3^rd party application
`canceled` ²	`targetId?`	The user canceled the share process
`failed` ²	`targetId?`	A system error occurred while sharing images
`screenshot`		The user took a screenshot of the SDK page

Parameters¶

Configuration¶

Parameter
`authType`
`welcomeScreenFeatureEnabled`
`onboardingFeatureEnabled`
`consentFeatureType`
`imagePickerCameraFeatureEnabled`
`imagePickerPredefinedModelFeatureEnabled`
`imagePickerUploadsHistoryFeatureEnabled`
`tryOnFitDisclaimerFeatureEnabled`
`tryOnFeedbackFeatureEnabled`
`tryOnFeedbackOtherFeatureEnabled`
`tryOnGenerationsHistoryFeatureEnabled`
`tryOnWithOtherPhotoFeatureEnabled`
`shareFeatureEnabled`
`shareWatermarkFeatureEnabled`
`wishlistFeatureEnabled`

Session¶

Flow	Description
`tryOn`	Starting the SDK with tryOn flow to upload photo and generate results
`history`	Starting the SDK to show previously generated gallery

The totalDuration time from when the user clicks the "Try On" button to when the results are displayed. It may be greater than the sum of the uploadDuration, tryOnDuration, and downloadDuration as it includes the request to start the operation and internal transitions. ↩
Available only on iOS. ↩↩