API Stability Long-Term

The updateSearchLinkInteraction() GraphQL mutation may be used to update a search link interaction.

Use the createSearchLinkInteraction() mutation to create a search link interaction. You can use deleteInteractionV2() to delete an interaction.

Hide Query Example

Show Repository Interactions Query

Syntax

graphql
updateSearchLinkInteraction(
      input: UpdateSearchLinkInteractionInput!
   ): InteractionId!

Example

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

Raw
graphql
mutation {
  updateSearchLinkInteraction(input:
       { path: "humio",
         interactionId: "abc123",
         searchLinkInteractionInput: 
            { name: "my-search-link", 
              queryString: "#vhost",
              isLive: false,
              arguments: [ {key: "some", value: "thing"} ],
              openInNewTab: false,
              useWidgetTimeWindow: false,
              fieldInteractionConditions: [ { fieldName: "my-field", 
                                              operator: Equal, 
                                              argument: "something" } ] }
      } )
  { id }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateSearchLinkInteraction(input:
       { path: \"humio\",
         interactionId: \"abc123\",
         searchLinkInteractionInput: 
            { name: \"my-search-link\", 
              queryString: \"#vhost\",
              isLive: false,
              arguments: [ {key: \"some\", value: \"thing\"} ],
              openInNewTab: false,
              useWidgetTimeWindow: false,
              fieldInteractionConditions: [ { fieldName: \"my-field\", 
                                              operator: Equal, 
                                              argument: \"something\" } ] }
      } )
  { id }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateSearchLinkInteraction(input:
       { path: \"humio\",
         interactionId: \"abc123\",
         searchLinkInteractionInput: 
            { name: \"my-search-link\", 
              queryString: \"#vhost\",
              isLive: false,
              arguments: [ {key: \"some\", value: \"thing\"} ],
              openInNewTab: false,
              useWidgetTimeWindow: false,
              fieldInteractionConditions: [ { fieldName: \"my-field\", 
                                              operator: Equal, 
                                              argument: \"something\" } ] }
      } )
  { id }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  updateSearchLinkInteraction(input: ^
       { path: \"humio\", ^
         interactionId: \"abc123\", ^
         searchLinkInteractionInput:  ^
            { name: \"my-search-link\",  ^
              queryString: \"#vhost\", ^
              isLive: false, ^
              arguments: [ {key: \"some\", value: \"thing\"} ], ^
              openInNewTab: false, ^
              useWidgetTimeWindow: false, ^
              fieldInteractionConditions: [ { fieldName: \"my-field\",  ^
                                              operator: Equal,  ^
                                              argument: \"something\" } ] } ^
      } ) ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateSearchLinkInteraction(input:
       { path: \"humio\",
         interactionId: \"abc123\",
         searchLinkInteractionInput: 
            { name: \"my-search-link\", 
              queryString: \"#vhost\",
              isLive: false,
              arguments: [ {key: \"some\", value: \"thing\"} ],
              openInNewTab: false,
              useWidgetTimeWindow: false,
              fieldInteractionConditions: [ { fieldName: \"my-field\", 
                                              operator: Equal, 
                                              argument: \"something\" } ] }
      } )
  { id }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  updateSearchLinkInteraction(input:
       { path: \"humio\",
         interactionId: \"abc123\",
         searchLinkInteractionInput: 
            { name: \"my-search-link\", 
              queryString: \"#vhost\",
              isLive: false,
              arguments: [ {key: \"some\", value: \"thing\"} ],
              openInNewTab: false,
              useWidgetTimeWindow: false,
              fieldInteractionConditions: [ { fieldName: \"my-field\", 
                                              operator: Equal, 
                                              argument: \"something\" } ] }
      } )
  { id }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
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
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  updateSearchLinkInteraction(input:
       { path: \"humio\",
         interactionId: \"abc123\",
         searchLinkInteractionInput: 
            { name: \"my-search-link\", 
              queryString: \"#vhost\",
              isLive: false,
              arguments: [ {key: \"some\", value: \"thing\"} ],
              openInNewTab: false,
              useWidgetTimeWindow: false,
              fieldInteractionConditions: [ { fieldName: \"my-field\", 
                                              operator: Equal, 
                                              argument: \"something\" } ] }
      } )
  { id }
}"
}'''

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

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  updateSearchLinkInteraction(input:
       { path: \"humio\",
         interactionId: \"abc123\",
         searchLinkInteractionInput: 
            { name: \"my-search-link\", 
              queryString: \"#vhost\",
              isLive: false,
              arguments: [ {key: \"some\", value: \"thing\"} ],
              openInNewTab: false,
              useWidgetTimeWindow: false,
              fieldInteractionConditions: [ { fieldName: \"my-field\", 
                                              operator: Equal, 
                                              argument: \"something\" } ] }
      } )
  { id }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  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
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "updateSearchLinkInteraction": {
      "id": "abc123"
    }
  }
}

Given Datatype

For the input datatype, you'll have to give the the unique identifier and path of the interaction you want to update. You would also provide, through sub-parameters, the name of the search link, its query string and any arguments. See the table below for more details and links to sub-parameters:

Table: UpdateSearchLinkInteractionInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Feb 26, 2025
interactionIdstringyes Long-TermThe unique identifier of the interaction.
pathstringyes Long-TermThe path of the interaction.
searchLinkInteractionInputSearchLinkInteractionInputyes Long-TermThe search link interaction data. See SearchLinkInteractionInput.

Returned Datatype

This datatype returns only the unique identifier of the interaction link. The table below provide a little more details:

Table: InteractionId

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 25, 2024
idstringyes Long-TermThe unique identifier for the interaction.