v1
latestOpenAPI 3.0.02026-08-04164892.0 KBalerting tasks
List data alert tasks
Retrieves all data alert tasks accessible to the user. Users assigned the TenantAdmin or AnalyticsAdmin role can view all tasks.
get/api/v1/data-alerts
Query parameters
appIDstring
The app ID you would like to filter by
conditionIdstring
The conditionId you would like to filter by
limitinteger
Limit the returned result set
nextstring
The cursor to the next page of data. Only one of next or previous may be specified.
offsetinteger
Offset for finding a list of entities - used for pagination
ownerIdstring
The id of the owner you would like to filter by
ownerNamestring
The name of the owner you would like to filter by
prevstring
The cursor to the previous page of data. Only one of next or previous may be specified.
rolestring[]
The role you would like to filter by
sortstring[]
Sort the returned result set by the specified field
statusstring[]
The status you would like to filter by
Response
The alerting tasks list has been successfully returned.
Example response
{
"links": {
"next": {
"href": "http://localhost:8787/v1/items?limit=12",
"type": "next",
"token": "JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA"
},
"prev": {
"href": "http://localhost:8787/v1/items?limit=12",
"type": "next",
"token": "JwAAAAJfaWQAGQAAADVjZjUwM2NjMjVkYzlhMTM1MzYwZTVjZAAA"
},
"self": {
"href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
}
},
"tasks": [
{
"id": "5da5825325dc9a0dd0260af9",
"links": {
"self": {
"href": "http://localhost:8787/v1/items/5da5825325dc9a0dd0260af9"
}
},
"recipients": {
"userIds": [
{
"value": "1b263bs8m0mm_s21s3f",
"groups": [
"addedIndividually",
"group1",
"group2"
],
"enabled": true,
"subscribed": true,
"taskRecipientErrors": [
{
"timestamp": "2019-10-15T16:07:01.492Z"
}
],
"alertingTaskRecipientErrors": [
{
"added": "2019-10-15T16:07:01.492Z"
}
]
}
],
"groupIds": [
{
"value": "group1",
"enabled": true,
"taskGroupRecipientErrors": [
{
"timestamp": "2019-10-15T16:07:01.492Z"
}
],
"alertingTaskGroupRecipientErrors": [
{
"added": "2019-10-15T16:07:01.492Z"
}
]
}
]
},
"dateCreated": "2019-10-15T16:07:01.492Z",
"lastUpdated": "2019-10-15T16:07:01.492Z",
"scheduleOptions": {
"timezone": "Canada/Pacific",
"recurrence": [
"RRULE:FREQ=HOURLY;INTERVAL=2"
],
"endDateTime": "2026-01-02T16:04:05",
"startDateTime": "2006-01-02T16:04:05",
"lastExecutionTime": "2020-11-20T12:00:55.000Z",
"nextExecutionTime": "2020-11-20T12:00:55.000Z"
},
"alertingTaskErrors": [
{
"added": "2019-10-15T16:07:01.492Z"
}
],
"recipientsChangeHistory": [
{
"patchAction": [
{
"op": "add",
"value": {
"value": "recipient-1",
"enabled": true
},
"recipientType": "userid"
},
{
"op": "remove",
"value": "I6mWVd60wRWIbOXZr1ZKV8QTnxhnitb",
"recipientType": "userid"
},
{
"op": "enable",
"value": "I6mWVd60wRWIbOXZr1ZKV8QTnxhnitb",
"recipientType": "userid"
},
{
"op": "disable",
"value": "I6mWVd60wRWIbOXZr1ZKV8QTnxhnitb",
"recipientType": "userid"
},
{
"op": "replace",
"value": [
{
"value": "recipient-1",
"enabled": true
},
{
"value": "recipient-2",
"enabled": false
}
],
"recipientType": "userid"
}
]
}
]
}
]
}