The deleteAggregateAlert() GraphQL mutation is used to delete an aggregate alert.

For more information on aggregate alerts, see the Aggregate Alerts documentation page.

Syntax

Below is the syntax for the deleteAggregateAlert() mutation field:

graphql
deleteAggregateAlert(
      input: DeleteAggregateAlert!
   ): boolean!

Given Datatypes

For the input, DeleteAggregateAlert, there are a couple of parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: DeleteAggregateAlert

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 18, 2024
idstringyes The unique identifier of the aggregate alert.
viewNameRepoOrViewNameyes The name of the view of the aggregate alert. RepoOrViewName is a scalar.