Profile Attributes (v4.1 & v5)

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 NameScopeTypeDefinition
siteIdv4, v4.1, v5StringThe siteId associated to the profile.
funnelv4, v4.1, v5StringThe funnel associated to the profile, set with the SET_FUNNEL command on the client SDK.
clientIdv4, v4.1, v5StringThe Neuro-Id tracked clientId associated to the profile.
deviceIdv4, v4.1, v5StringThe deviceId associated to the profile. Only available when the siteId is configured for device+network.
registeredUserIdv4, v4.1, v5StringThe registeredUserId associated to the profile. Set with the SET_REGISTERED_USER_ID command in the client SDK.
useCaseNamev5StringThe useCase the siteId is associated to. Configured in the Neuro-Id customer portal.
productTypev5StringThe product type associated to the siteId one of the following: AO, AD - Login, AD - Post Login