latestOpenAPI 3.0.12026-08-188456240.4 KB

6e6982573ba6

Preview alert widget

post/api/2.0/alerts/preview

Request body

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 request

{
  "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"
      }
    ]
  }
}

Response

Success

createdDateinteger

Created date in milliseconds

lastModDateinteger

Last modified date

idinteger

Widget ID

namestring

Widget name

userIdinteger

Widget owner's user ID

customerIdinteger

Widget owner's customer ID

datasetIdinteger

Dataset ID

typeinteger

Widget type

descriptionstring

Widget description

refreshChartMillisinteger

shareUrlstring

Share URL identifier

secureShareUrlstring

Secure share URL identifier

accessLevelinteger

Access level of the report for current user

certifiedboolean

autoSharedboolean

Is report auto-shared on

urlShareWhitelistDomainstring[]

filterSettingsstring

chartTypestring

alertCountinteger

incognitoIdinteger

queryIdinteger

queryStrstring

adhocQuerystring

categoriesinteger[]

queryModifiedboolean

updateFiltersboolean

dataFieldsstring[]

dataFieldsTypesobject

typeModifiedboolean

lastSyncDatestring date-time

viewOnlyboolean

truncatedstring[]

processedNamestring

processedDescriptionstring

processedFootNotestring

errorstring

paginationobject

pagedDataTransformationWarningstring

processedChartPropertiesobject

notDefaultFilterboolean

minMaxobject

chartPropertiesobject

widgetAccessLevelinteger

chartPropertiesNullOrEmptyboolean

repeatableWidgetboolean

repeatableWidgetFeatureEnabledboolean

dataDisplayTypesobject

dbFieldsstring[]

ignoreValsstring[]

widgetTypeStrstring

filterFieldDataTypesIncludingNestedobject

filteringResultFieldsobject

filterFieldDataTypesobject

ntzColumnsstring[]

liveboolean

fieldsstring[]

Example response

{
  "associations": {
    "drilldowns": [
      {
        "filters": [
          {
            "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"
          }
        ]
      }
    ]
  },
  "widgetConfig": {
    "filters": [
      {
        "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"
      }
    ],
    "defaultFilters": [
      {
        "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"
      }
    ]
  },
  "drilldowns": [
    {
      "filters": [
        {
          "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"
        }
      ]
    }
  ],
  "filters": [
    {
      "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"
    }
  ],
  "user": {
    "userGroups": [
      {
        "contentFilters": [
          {
            "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"
          }
        ]
      }
    ],
    "userProperties": {
      "userContentFilters": [
        {
          "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"
        }
      ],
      "customerContentFilters": [
        {
          "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"
        }
      ],
      "groupContentFilters": [
        {
          "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"
        }
      ],
      "sharedContentFilters": [
        {
          "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"
        }
      ],
      "contentFilters": [
        {
          "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"
        }
      ]
    },
    "selectedDashInternal": {
      "defaultFilterSets": [
        {
          "filters": [
            {
              "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"
            }
          ]
        }
      ],
      "properties": {
        "filters": [
          {
            "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"
          }
        ],
        "defaultFilters": [
          {
            "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"
          }
        ],
        "filterSets": [
          {
            "filters": [
              {
                "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"
              }
            ]
          }
        ],
        "defaultFilterSets": [
          {
            "filters": [
              {
                "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"
              }
            ]
          }
        ]
      },
      "propertiesInternally": {
        "filters": [
          {
            "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"
          }
        ],
        "defaultFilters": [
          {
            "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"
          }
        ],
        "filterSets": [
          {
            "filters": [
              {
                "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"
              }
            ]
          }
        ],
        "defaultFilterSets": [
          {
            "filters": [
              {
                "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"
              }
            ]
          }
        ]
      }
    }
  },
  "drilldownFilters": [
    {
      "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"
    }
  ],
  "displayableFilters": [
    {
      "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"
    }
  ]
}