Manage Notifications
Activity API reference guide
This page describes the activity
endpoint of the Immuta API, which allows you to view your activity notifications.
Additional fields may be included in some responses you receive; however, these attributes are for internal purposes and are therefore undocumented.
Review your notifications
GET
/activity
GET
/activity/hasUnread
Review your activity notifications
GET
/activity
View your activity notification feed.
Query parameters
excludeMine
boolean
If true
, excludes activities that were initiated by the calling user.
No
nonRequestActivity
boolean
If true, excludes data source access requests from the returned activities.
No
new
boolean
If true
, excludes activities that are marked as 'read'.
No
offset
integer
Used in combination with size
to fetch pages.
No
size
integer
The number of records to return in this query.
No
modelType
string
The type of object to get activity for (i.e., data source, script, etc.).
No
modelId
string
The ID for the model (i.e., the data source ID).
No
sortField
string
The field to use for sorting.
No
sortOrder
string
The sort order to use. The default is desc
.
No
searchText
string
If set, will use text to search through notification types and return all matched types.
No
notificationType
string
If set, will only return activities of this type.
No
permission
string
If set, will only return activities from users with a given permission if current user has it as well.
No
Response parameters
count
integer
The total number of results available.
unread
integer
The number of unread activities.
activities
metadata
The information about the individual activities.
Request example
This example request gets 5 activities for the current user and sorts them in descending order.
Response example
Review your unread notifications
GET
/activity/hasUnread
Determine whether you have unread activity notifications.
Response parameters
unread
boolean
If true
, the user has unread activities.
Request example
This request determines whether or not the requesting user has unread activities.
Response example
Last updated