Activity API reference guide
This page describes the activity endpoint of the Immuta API, which allows you to view your activity notifications.
GET /activity
View your activity notification feed.
This example request gets 5 activities for the current user and sorts them in descending order.
GET /activity/hasUnread
Determine whether you have unread activity notifications.
This request determines whether or not the requesting user has unread activities.
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
GET
/activity
GET
/activity/hasUnread
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.
count
integer The total number of results available.
unread
integer The number of unread activities.
activities
metadata The information about the individual activities.
unread
boolean If true, the user has unread activities.
No
curl \
--request GET \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
https://demo.immuta.com/activity?size=5&sortOrder=desc{
"count": 210,
"activities": [
{
"modelType": "datasource",
"modelId": "105",
"createdAt": "2021-05-04T18:39:08.712Z",
"notificationType": "modelUserDeleted",
"metadata": {
"dataSourceName": "Public Uciml Census Income Enriched",
"activity": "access",
"action": "revoked"
},
"read": false,
"id": 1255,
"updatedAt": "2021-05-04T18:39:08.712Z",
"actionBy": {
"id": 2,
"name": "John",
"email": "[email protected]"
},
"targetUser": {
"id": 2,
"name": "John",
"email": "[email protected]"
}
},
{
"modelType": "datasource",
"modelId": "106",
"createdAt": "2021-05-04T18:39:08.696Z",
"notificationType": "modelUserDeleted",
"metadata": {
"dataSourceName": "Public Fake Medical Claims 2017",
"activity": "access",
"action": "revoked"
},
"read": false,
"id": 1254,
"updatedAt": "2021-05-04T18:39:08.696Z",
"actionBy": {
"id": 2,
"name": "John",
"email": "[email protected]"
},
"targetUser": {
"id": 2,
"name": "John",
"email": "[email protected]"
}
},
{
"modelType": "datasource",
"modelId": "105",
"createdAt": "2021-05-04T18:39:08.649Z",
"notificationType": "modelDeleted",
"metadata": {
"dataSourceName": "Public Uciml Census Income Enriched",
"fields": {
"deleted": true
}
},
"read": false,
"id": 1253,
"updatedAt": "2021-05-04T18:39:08.649Z",
"actionBy": {
"id": 2,
"name": "John",
"email": "[email protected]"
},
"targetUser": {
"id": 2,
"name": "John",
"email": "[email protected]"
}
},
{
"modelType": "datasource",
"modelId": "106",
"createdAt": "2021-05-04T18:39:08.650Z",
"notificationType": "modelDeleted",
"metadata": {
"dataSourceName": "Public Fake Medical Claims 2017",
"fields": {
"deleted": true
}
},
"read": false,
"id": 1252,
"updatedAt": "2021-05-04T18:39:08.650Z",
"actionBy": {
"id": 2,
"name": "John",
"email": "[email protected]"
},
"targetUser": {
"id": 2,
"name": "John",
"email": "[email protected]"
}
},
{
"modelType": "datasource",
"modelId": "103",
"createdAt": "2021-05-04T18:39:08.555Z",
"notificationType": "modelUserDeleted",
"metadata": {
"dataSourceName": "Public Credit Transactions",
"activity": "access",
"action": "revoked"
},
"read": false,
"id": 1251,
"updatedAt": "2021-05-04T18:39:08.555Z",
"actionBy": {
"id": 2,
"name": "John",
"email": "[email protected]"
},
"targetUser": {
"id": 2,
"name": "John",
"email": "[email protected]"
}
}
],
"unread": 210,
"next": "1251_2021-05-04T18:39:08.555Z"
}curl \
--request GET \
--header "Content-Type: application/json" \
--header "Authorization: Bearer dea464c07bd07300095caa8" \
https://demo.immuta.com/activity/hasUnread{
"unread": false
}