Interaction Attributes (v4.1 & v5)

Interaction Attributes are session-level metadata summarizing the collected interaction data.

The Interaction Attributes are not associated with any particular signal (scores, indicators,
etc.) and, as such, appear under the “profile” node in the API response. Some attributes are specific to a certain behavioral model. Ensure that the behavioral model which you have configured is appropriate for the interaction attributes you expect to receive.

Example

"interactionAttributes": {
  "client_id_count": 1,
  "elapsed_time_ms": 1792832,
  "interaction_time_ms": 923093,
  "ip_geolocation": {},
  "session_id_count": 2,
  "unique_all_targets_count": 3,
  "unique_known_targets_count": 3,
  "unique_unknown_targets_count": 0,
  "user_id_count": 1
}

Definitions

Attribute NameScopeTypeBehavioral ModelDefinition
client_id_countDevice / User Cardinalityint2.5, 2.7, 3.0The number of distinct client_ids associated with a user_id; represents the number of different browsers/devices a user_id uses to interact with the application.
elapsed_time_msSessionint2.5, 2.7Elapsed time from calling start() to the timestamp from the most recently processed event in milliseconds.
fields_interacted_countSessionint2.5, 2.7The number of unique targets the user has interacted with up to this point in the application.
interaction_time_msSessionint2.5, 2.7Total time spent interacting with the form fields in the application in milliseconds.
ip_geolocationSessionobjectadvanced_deviceIf purchased, it contains the IP geolocation information referenced below. This includes an Accuracy Radius that is an approximate measurement in kilometers around the IP Address location.
unique_all_targets_countAll text fieldsint2.5, 2.7The number of unique targets the user has interacted with up to this point in the application.
unique_known_targets_countHigh-familiarity text fieldsint2.5, 2.7The number of unique high-familiarity targets the user has interacted with up to this point in the application.
unique_unknown_targets_countLow-familiarity text fieldsint2.5, 2.7The number of unique low-familiarity targets the user has interacted with up to this point in the application.
session_id_countDevice / User Cardinalityint2.5, 2.7, 3.0The number of sessions a user_id is associated with; the session is defined as a set of interaction data bounded by 30 minutes of idle time; represents the number of interactions it takes a user_id to “complete” the application.
user_id_countCardinalityint2.5, 2.7, 3.0The number of user identifiers set to the specific session.

IP Geolocation

The IP Geolocation is included in interactionAttributes as ip_geolocation if this feature has been purchased as part of the Advanced Device Package.

"interactionAttributes": {
  "ip_geolocation": {
    "accuracyRadius": <number>,
    "latitude": <number>,
    "longitude": <number>,
    "postalCode": <number>,
    "timezone": "string",
    "city": {
      "name": "string"
    },
    "country": {
      "code": "string",
      "name": "string"
    },
    "continent": {
      "code": "string",
      "name": "string"
    },
    "subdivisions": [
      {
        "isoCode": "string",
        "name": "string"
      }
    ]
  }
}
"interactionAttributes": {
  "ip_geolocation": {
    "error": "Insufficient data: Geolocation lookup has not completed"
  }
}
"interactionAttributes": {
  "ip_geolocation": {
    "error": "Insufficient data: Geolocation data unavailable for session"
  }
}