latestOpenAPI 3.0.12026-08-188456240.4 KB

6e6982573ba6

Retrieve an alert with specific ID

get/api/2.0/alerts/{objectId}

Path parameters

objectIdinteger required

Alert ID to be retrieved

Response

Success

createdDateinteger

Created date in milliseconds

lastModDateinteger

Last modified date

idinteger

Alert ID

datasetIdinteger

Dataset ID

lastAlertstring date-time

Last alert date

userIdinteger

Alert owner's user ID

statusinteger

Alert status

alertConditionstring

Alert condition for conditional alert type

alertNamestring

Alert name

alertTypeinteger

Alert type

accessLevelinteger

Access level of the alert for current user

autoSharedboolean

Is alert auto-shared on

realtimeboolean

Whether or not this alert is real-time alert

firedCountinteger

Number of times this alert has been triggered

createdBystring

Alert owner's username

deletableboolean

Whether or not the current user has deletion right to the alert

chartIdinteger

Widget ID

Example response

{
  "schedule": {
    "frequencyType": "daily,day,days,weekday,weekdays,hour,hourly,hours,minute,minutes,minutely,week,weeks,weekly,month,months,monthly"
  },
  "properties": {
    "alertContentFilters": [
      {
        "operator": "=,!=,>,>=,<,<=,Equals,Not Equals,Greater than,Greater than or equals,Less than,Less than or equals,is null,is not null,Range,Contains,Does Not Contain",
        "controlType": "single,picker,slider,range_time_slider",
        "plainControlType": "single,multiple,tree,custom"
      }
    ]
  }
}