Track your users in Transaction Data
This section covers the different ways to access Transaction Data and the different use cases associated
Introduction
There are two main documented properties that gives our client information about the progress of the user in TD journey :
- state : property linked to a session.
- userJourneyState : property linked to a customer.
state property
You can track the user through the property state
accessible in the route GET /v2/sessions/{sessionId}/session-data
This property gives a synthetic view of the progress of the user in a given session.
These states reflect the user's progress within Transaction Data:
state=IN_PROGRESS
when the user has entered Transaction Datastate=SUCCESS
when the user has successfully aggregated their accountstate=EXIT
when the user has left Transaction Datastate=ERROR
when the user has encountered an errorstate=EXPIRED
when the user's session has expired
userJourneyState property
This property gives a detailed view of the progress of the user inside Transaction Data Journey across its associated sessions. It can be used at the micro level to understand where a user has dropped off or at the macro level to build conversion funnels.
If there are multiple sessions, userJourneyState
value will be based on the session in which the user progressed the furthest in the journey.
userJourneyState is documented here https://docs.algoan.com/api-reference#getcustomerbyid
Here are the values of userJouneyState
:
CUSTOMER_CREATED | The customer is created |
STARTED | The user has arrived on TD |
BANK_SELECTED | The user has selected a bank |
QR_CODE_ SCANNED | The user has scanned the QR code to continue the process on his mobile |
AGGREGATION_STARTED | The user has been redirected to bank website/app |
AGGREGATION_FINISHED_ SUCCESS | The user has been redirected to TD successfully |
AGGREGATION_FINISHED_ ERROR | The user has been redirected to TD with error |
FINISHED_SUCCESS | The user has been redirected to the defined redirect_uri after at least one successful aggregation. |
FINISHED_ERROR | The user has been redirected to the defined redirect_uri without successful aggregation. |
ANALYSIS_SUCCESS | The analysis has been created and completed |
ANALYSIS_ERROR | The analysis has been created and error |