Skip to main content

Useractivities Model

Overview​

Tracks user activities within an application, capturing interaction details, the specific actions performed, and associated metadata.

Fields​

FieldTypeDescriptionRequired
idstringA unique identifier for the user activity. Serves as the primary key for identifying each user interaction event.❌
interaction_typestringThe type of interaction performed by the user. Useful for filtering activity types or performing analytics.❌
sites_idstringThe identifier of the site where the activity occurred.❌
org_idstringThe identifier of the organization associated with the activity. Important in multi-tenant systems.❌
application_idstringThe identifier of the application where the activity was recorded.❌
user_idstringThe identifier of the user who performed the activity.❌
orggroup_idstringThe identifier of the organizational group associated with the user.❌
menustringThe menu section where the interaction took place.Helps in understanding navigation flows or UI-specific engagement.❌
screen_namestringThe name of the screen or module where the activity was performed.❌
api_urlstringThe API endpoint related to the interaction, if applicable. Useful for debugging, performance monitoring, or security auditing.❌
object_idstringThe identifier of the object related to the activity. Helps connect user actions with entities in the system.❌
messageanyA detailed description or log of the activity.❌
device_infoobjectInformation about the device used for the activity, typically stored in text format. Important for security, fraud detection, or user analytics.✅
created_atdateThe timestamp when the activity was recorded.❌
modified_atdateThe timestamp when the activity was last updated.❌
build_typestringThe build version or type of the application used during the interaction.❌
dataobjectAny additional data related to the activity, typically in long text format. Useful for detailed audit trails.❌
data_typestringSpecifies the type of data in the data field, such as "json", "xml", "form", etc.❌
action_fromstringThe source of the action. Useful for understanding how users are interacting with your platform.❌

Sample JSON​

{
"id": "example_value",
"interaction_type": "example_value",
"sites_id": "example_value",
"org_id": "example_value",
"application_id": "example_value",
"user_id": "example_value",
"orggroup_id": "example_value",
"menu": "example_value",
"screen_name": "example_value",
"api_url": "example_value",
"object_id": "example_value",
"message": "example_value",
"device_info": "example_value",
"created_at": "example_value",
"modified_at": "example_value",
"build_type": "example_value",
"data": "example_value",
"data_type": "example_value",
"action_from": "example_value"
}