Basic Profile Identifiers
Profile Attributes
are the basic identifiers associated to the profile
. A profile will be returned when requested by sessionId
OR registeredUserId
for the respective endpoints. Multiple Profiles will be returned when requests are made to the v5
endpoint. These attributes help you differentiate between different profiles.
Example
{
"siteId": "siteIdString",
"funnel": "funnel",
"clientId": "d8ff15d4-5a7b-45ff-b960-3892a6d8e8c8",
"deviceId": "deviceIdString",
"registeredUserId": "registeredUserIdString",
"useCaseName": "Login",
"productType": "AD_LOGIN",
}
Definitions
Attribute Name | Scope | Type | Definition |
---|---|---|---|
siteId | v4, v4.1, v5 | String | The siteId associated to the profile. |
funnel | v4, v4.1, v5 | String | The funnel associated to the profile, set with the SET_FUNNEL command on the client SDK. |
clientId | v4, v4.1, v5 | String | The Neuro-Id tracked clientId associated to the profile. |
deviceId | v4, v4.1, v5 | String | The deviceId associated to the profile. Only available when the siteId is configured for device+network. |
registeredUserId | v4, v4.1, v5 | String | The registeredUserId associated to the profile. Set with the SET_REGISTERED_USER_ID command in the client SDK. |
useCaseName | v5 | String | The useCase the siteId is associated to. Configured in the Neuro-Id customer portal. |
productType | v5 | String | The product type associated to the siteId one of the following: AO , AD - Login , AD - Post Login |