Type Alias DataAlertsAPI

type DataAlertsAPI = {
    clearCache: typeof clearCache;
    createDataAlert: typeof createDataAlert;
    deleteDataAlert: typeof deleteDataAlert;
    deleteDataAlertExecution: typeof deleteDataAlertExecution;
    getDataAlert: typeof getDataAlert;
    getDataAlertCondition: typeof getDataAlertCondition;
    getDataAlertExecution: typeof getDataAlertExecution;
    getDataAlertExecutionEvaluations: typeof getDataAlertExecutionEvaluations;
    getDataAlertExecutions: typeof getDataAlertExecutions;
    getDataAlertExecutionsStats: typeof getDataAlertExecutionsStats;
    getDataAlertRecipientStats: typeof getDataAlertRecipientStats;
    getDataAlerts: typeof getDataAlerts;
    getDataAlertsSettings: typeof getDataAlertsSettings;
    patchDataAlert: typeof patchDataAlert;
    setDataAlertsSettings: typeof setDataAlertsSettings;
    triggerDataAlerts: typeof triggerDataAlerts;
    validateDataAlerts: typeof validateDataAlerts;
}
Index

Properties

clearCache createDataAlert deleteDataAlert deleteDataAlertExecution getDataAlert getDataAlertCondition getDataAlertExecution getDataAlertExecutionEvaluations getDataAlertExecutions getDataAlertExecutionsStats getDataAlertRecipientStats getDataAlerts getDataAlertsSettings patchDataAlert setDataAlertsSettings triggerDataAlerts validateDataAlerts

Properties

clearCache: typeof clearCache

Clears the cache for data-alerts api requests.

createDataAlert: typeof createDataAlert

Creates a new data alerting task.

Param: body

an object with the body content

CreateDataAlertHttpError

deleteDataAlert: typeof deleteDataAlert

Deletes a specific data alerting task.

The alerting task identifier.

DeleteDataAlertHttpError

deleteDataAlertExecution: typeof deleteDataAlertExecution

Deletes a specific data alerting task execution.

The alerting task identifier.

The execution identifier.

DeleteDataAlertExecutionHttpError

getDataAlert: typeof getDataAlert

Returns the details of a specific data alert task.

The alerting task identifier.

GetDataAlertHttpError

getDataAlertCondition: typeof getDataAlertCondition

Retrieves the condition associated with a data alerting task.

The alerting task identifier.

GetDataAlertConditionHttpError

getDataAlertExecution: typeof getDataAlertExecution

Retrieves a specific execution for the specified data alerting task.

The alerting task identifier.

The execution identifier. If value is "latest", the latest execution will be returned

GetDataAlertExecutionHttpError

getDataAlertExecutionEvaluations: typeof getDataAlertExecutionEvaluations

Retrieves the content of an evaluation for a specified data alerting task execution.

The alerting task identifier.

The execution identifier.

GetDataAlertExecutionEvaluationsHttpError

getDataAlertExecutions: typeof getDataAlertExecutions

Lists executions for the specified data alerting task.

The alerting task identifier.

an object with query parameters

GetDataAlertExecutionsHttpError

getDataAlertExecutionsStats: typeof getDataAlertExecutionsStats

Retrieves stats for overall data alerting task executions.

The alerting task identifier.

an object with query parameters

GetDataAlertExecutionsStatsHttpError

getDataAlertRecipientStats: typeof getDataAlertRecipientStats

Retrieve the recipient stats for a data alerting task.

The alerting task identifier.

an object with query parameters

GetDataAlertRecipientStatsHttpError

getDataAlerts: typeof getDataAlerts

Retrieves all data alert tasks accessible to the user. Users assigned the TenantAdmin or AnalyticsAdmin role can view all tasks.

an object with query parameters

GetDataAlertsHttpError

getDataAlertsSettings: typeof getDataAlertsSettings

Retrieves the current settings for data alerts.

GetDataAlertsSettingsHttpError

patchDataAlert: typeof patchDataAlert

Updates one or more properties of a specific data alerting task.

The alerting task identifier.

Param: body

an object with the body content

PatchDataAlertHttpError

setDataAlertsSettings: typeof setDataAlertsSettings

Updates the settings for data alerts. User must be assigned the TenantAdmin role.

Param: body

an object with the body content

SetDataAlertsSettingsHttpError

triggerDataAlerts: typeof triggerDataAlerts

Creates a new data alerting task trigger action.

Param: body

an object with the body content

TriggerDataAlertsHttpError

validateDataAlerts: typeof validateDataAlerts

Validates a new data alerting task. Current support includes validation for recipients only.

Param: body

an object with the body content

ValidateDataAlertsHttpError

Settings

Member Visibility

On This Page

Properties