Namespace: Activity

Methods

Appearition.User.Activity.LogActivity (request, requestOptions) static

Logs an activity made by a user

Name	Type	Description
request	Appearition.User.Activity.LogActivityRequest	Contains the parameters for submitting activity to the platform
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Appearition.User.Activity.Search (request, requestOptions)Array.<Appearition.User.Activity.UserActivityViewModel> static

Searches and retrieves a list of user activity records based on the criteria specified in the request.

Name	Type	Description
request	Appearition.User.Activity.UserActivitySearchRequest	Contains the parameters for searching and filtering results
requestOptions	Appearition.RequestOptions	Contains the various callback methods for this request

Returns:

Type	Description
Array.<Appearition.User.Activity.UserActivityViewModel>	This is returned as part of the success callback function in the requestOptions param

Type Definitions

Appearition.User.Activity.LogActivityRequest

This data structure holds the search criteria used to filter records on the platform. Note, tenant key and username will be picked up based on the credentials of the request

Properties:

Name	Type	Description
ChannelId	number	If authorised, you can log activity for different channels. If supplied and you are not authorised, an error will be returned. If left empty, will default to the channel id in the request url
ModuleName	string	The name of the module which the activity came from.
Activity	string	Text description of the activity

Appearition.User.Activity.UserActivitySearchRequest

This data structure holds the search criteria used to filter records on the platform

Properties:

Name	Type	Description
TenantKey	string	If authorised, you can filter user activity results by TenantKey. If not, the search will override this property and use the actual tenant that the request was made from
Username	string	If authorised, you can filter user activity results for different users. If not, the search will override this property and use the logged in username
ChannelId	number	If authorised, you can filter user activity results for different channels. If not, the search will override this property and use the logged in users channel id
ModuleName	string	You can filter results by a specific module. This property supports partial text searching
Activity	string	You can filter results by a specific action that has been logged. This property supports partial text searching
FromUtcDate	string	You can filter results from a specific date. Activity date is recorded in GMT. The format expected is yyyy-MM-ddTHH:mm:ss:ZZZ. If this field is left empty, the search will use the date of Monday of this current week
ToUtcDate	string	You can filter results up to a specific date. Activity date is recorded in GMT. The format expected is yyyy-MM-ddTHH:mm:ss:ZZZ. If this field is left empty, the search will use the current date and time in GMT
Page	number	Specify which page of the results to return. Zero based index
RecordsPerPage	number	Specify how many records each page should return

Appearition.User.Activity.UserActivityViewModel

Represents the details of a specific activity logged for a user.

Properties:

Name	Type	Description
TenantKey	string	The unique identifier of the tenant the activity was recorded from
Username	string	Uniquely identifies the user who performed/triggered the activity
ChannelId	number	Identifies the channel in which the activity took place in
ModuleName	string	The name of the module which the activity came from
Activity	string	Text description of the activity
ActivityUtcDate	string	Date and time in GMT when the activity was logged. Form is yyyy-MM-ddTHH:mm:ss:ZZZ