addStarToAlertV2( )

Attention

Under Development

Our GraphQL pages are currently under development. The content, links, tables, and structure of this material may change without notice.

The addstartoalertv2 GraphQL mutation field used to add a star to an alert.

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

Syntax

Below is the syntax for the AddStarToAlertV2 mutation field:

addStarToAlertV2(input: AddStarToAlert!): Alert!
Given Datatypes

For the input (i.e., AddStarToAlert), there is only the input parameter. With it, for the input data, you would provide the data using the AddStarToAlert input method. Below is a list of requirements for it:

Table: QueryQuotaDefaultSettingsInput

ParameterTypeRequired[a]DefaultDescription
viewNamestringyes input adduserinputv2 The name of the view of the alert.
idstringyes The unique identifier of the alert.

[a] Some arguments may be required, as indicated in this column. For some fields this column indicates that a result will always being returned for it.


Returned Datatypes

As indicated by the syntax above, this mutation will return data using the Alert datatype. Below is a list of the parameters of that datatype:

Table: Alert

ParameterTypeRequired[a]DefaultDescription
runAsUserUser  datatype alert Identifier of user by which the alert is run.
displayNamestringyes Name of the alert.
descriptionstringyes Description of alert.
queryStringstringyes Humio query to execute.
queryStartstringyes Start of the relative time interval for the query.
throttleTimeMillislongyes Throttle time in milliseconds.
throttleFieldstring  Field on which to throttle alert.
timeOfLastTriggerlong  UNIX timestamp for when the alert was last triggered.
enabledbooleanyes Flag indicating whether the alert is enabled.
actionsstringyes List of identifiers for actions to fire on query result.
lastErrorstring  Last error encountered while running the alert.
labelsstringyes Labels attached to the alert.
isStarredbooleanyes Whether the calling user has starred the alert.
yamlTemplatestringyes A YAML formatted string that describes the alert.
packagePackageInstallation  A package installation (see PackageInstallation Table).
idstringyes The identifier of the alert.
namestringyes The name of the alert.
assetTypeAssetTypeyes The type of asset from an enumerated list: ScheduledSearch, Action, File, Alert, Parser, SavedQuery, Dashboard.

[a] Some arguments may be required, as indicated in this column. For some fields this column indicates that a result will always being returned for it.


For the Alert parameters, there are a couple of special datatypes. One is the AssetType, but that merely requires a choice from an enumerate list, which is given in the Alert table above.

The other returned datatypes and their parameters in turn are more complex. You can click on the links below for more information on those various parameters: