API Stability Long-Term

The addStarToField() GraphQL mutation is used to add a star to a field.

For more information on fields, see the Event Fields documentation page.

Syntax

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

graphql
addStarToField(
      input: AddStarToFieldInput!
   ): AddStarToFieldMutation!

Below is an example of how this mutation field might be used:

Show:
graphql
mutation {
  addStarToField(input: 
       { fieldName: "connectionSource"
         searchDomainName: "humio" } )
  { starredFields }
}
Example Responses
Show:
json
{
  "data": {
    "addStarToField": {
      "starredFields": [
        "@timestamp",
        "connectionSource"
      ]
    }
  }
}

Given Datatypes

AddStarToFieldInput has a couple of parameters. They're listed below along with a description of each:

Table: AddStarToFieldInput

ParameterTypeRequiredDefaultStabilityDescription
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 17, 2024
fieldNamestringyes Long-TermThe name of the field to mark with a star.
searchDomainNamestringyes Long-TermThe search domain where the field can be found.

Returned Datatypes

AddStarToFieldMutation has one parameter. It's described below:

Table: AddStarToFieldMutation

ParameterTypeRequiredDefaultStabilityDescription
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 23, 2024
starredFields[string]yes Long-TermThe fields on which to add stars.