updateSavedQuery()

API Stability	`Long-Term`

The updateSavedQuery() GraphQL mutation is used to update a saved query in LogScale.

For more information on saved queries, see the User Functions (Saved Searches) reference page where saved queries are discussed. Also, look at the Searching Data documentation page as it relates to recent queries and saving queries.

Syntax

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

graphql

updateSavedQuery(
     input: UpdateSavedQueryInput!
   ): UpdateSavedQueryPayload!

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

Show:

graphql

mutation {
  updateSavedQuery( input:
     { id: "abc123",
       viewName: "humio",
       isLive: false
     } 
  )
  { savedQuery { id } }
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateSavedQuery( input:
     { id: \"abc123\",
       viewName: \"humio\",
       isLive: false
     } 
  )
  { savedQuery { id } }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateSavedQuery( input:
     { id: \"abc123\",
       viewName: \"humio\",
       isLive: false
     } 
  )
  { savedQuery { id } }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  updateSavedQuery( input: ^
     { id: \"abc123\", ^
       viewName: \"humio\", ^
       isLive: false ^
     }  ^
  ) ^
  { savedQuery { id } } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateSavedQuery( input:
     { id: \"abc123\",
       viewName: \"humio\",
       isLive: false
     } 
  )
  { savedQuery { id } }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  updateSavedQuery( input:
     { id: \"abc123\",
       viewName: \"humio\",
       isLive: false
     } 
  )
  { savedQuery { id } }
}"
}';
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";

python

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  updateSavedQuery( input:
     { id: \"abc123\",
       viewName: \"humio\",
       isLive: false
     } 
  )
  { savedQuery { id } }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  updateSavedQuery( input:
     { id: \"abc123\",
       viewName: \"humio\",
       isLive: false
     } 
  )
  { savedQuery { id } }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  path: '/graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();

Example Responses

Show:

json

{
  "data": {
    "updateSavedQuery": {
      "savedQuery": {
        "id": "abc123"
      }
    }
  }
}

Given Datatypes

UpdateSavedQueryInput has many parameters that may be given. Below is a list of them along with a description of each:

Table: UpdateSavedQueryInput

Parameter	Type	Required	Stability	Description
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
`customLinkInteractions`	[`CustomLinkInteractionInput`]	yes	`Long-Term`	The custom links for interactions. See `CustomLinkInteractionInput`.
`dashboardLinkInteractions`	[`DashboardLinkInteractionInput`]	yes	`Long-Term`	The dashboard links for interactions. See `DashboardLinkInteractionInput`.
`end`	string		`Long-Term`	The ending point of the saved query.
`id`	string	yes	`Long-Term`	The unique identifier of the saved query to update.
`isLive`	boolean		`Long-Term`	Whether the saved query is executed continuously on live, streaming data.
`name`	string		`Long-Term`	The name of the saved query to update.
`options`	string		`Long-Term`	Any options related to the saved query.
`queryString`	string		`Long-Term`	The new query.
`searchLinkInteractions`	[`SearchLinkInteractionInput`]	yes	`Long-Term`	The search links for interactions. See `SearchLinkInteractionInput`.
`start`	string		`Long-Term`	The starting point of the saved query.
`updateParametersInteractions`	[`UpdateParametersInteractionInput`]	yes	`Long-Term`	The parameters to update for interactions. See `UpdateParametersInteractionInput`.
`viewName`	string	yes	`Long-Term`	The name of the view associated with the saved query.
`widgetType`	string		`Long-Term`	The type of widget for displaying the results of the saved query.

Returned Datatypes

The returned datatype UpdateSavedQueryPayload has one parameter and several sub-parameters. Click on the link below to see a table containing the sub-parameters:

Table: UpdateSavedQueryPayload

Parameter	Type	Required	Stability	Description
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: Oct 4, 2024
`savedQuery`	`savedQuery`	yes	`Long-Term`	The saved query to update. See `savedQuery`.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes