createSearchLinkInteraction()

API Stability	`Long-Term`

The createSearchLinkInteraction() GraphQL mutation field is used to create a search link interaction. This is a preview and may change.

Syntax

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

graphql

createSearchLinkInteraction(
       input: CreateSearchLinkInteractionInput!
    ): InteractionId!

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

Show:

graphql

mutation {
  createSearchLinkInteraction(input:
       { path: "humio",
         searchLinkInteractionInput: { 
             name: "my-search-link", 
             repoOrViewName: "humio", 
             isLive: true, openInNewTab: true,
             useWidgetTimeWindow: true,
             queryString: "#vhost",
             arguments: [ {key: "some", value: "thing"} ] }
      } )
  { id }
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  createSearchLinkInteraction(input:
       { path: \"humio\",
         searchLinkInteractionInput: { 
             name: \"my-search-link\", 
             repoOrViewName: \"humio\", 
             isLive: true, openInNewTab: true,
             useWidgetTimeWindow: true,
             queryString: \"#vhost\",
             arguments: [ {key: \"some\", value: \"thing\"} ] }
      } )
  { id }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  createSearchLinkInteraction(input:
       { path: \"humio\",
         searchLinkInteractionInput: { 
             name: \"my-search-link\", 
             repoOrViewName: \"humio\", 
             isLive: true, openInNewTab: true,
             useWidgetTimeWindow: true,
             queryString: \"#vhost\",
             arguments: [ {key: \"some\", value: \"thing\"} ] }
      } )
  { id }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  createSearchLinkInteraction(input: ^
       { path: \"humio\", ^
         searchLinkInteractionInput: {  ^
             name: \"my-search-link\",  ^
             repoOrViewName: \"humio\",  ^
             isLive: true, openInNewTab: true, ^
             useWidgetTimeWindow: true, ^
             queryString: \"#vhost\", ^
             arguments: [ {key: \"some\", value: \"thing\"} ] } ^
      } ) ^
  { id } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createSearchLinkInteraction(input:
       { path: \"humio\",
         searchLinkInteractionInput: { 
             name: \"my-search-link\", 
             repoOrViewName: \"humio\", 
             isLive: true, openInNewTab: true,
             useWidgetTimeWindow: true,
             queryString: \"#vhost\",
             arguments: [ {key: \"some\", value: \"thing\"} ] }
      } )
  { 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 {
  createSearchLinkInteraction(input:
       { path: \"humio\",
         searchLinkInteractionInput: { 
             name: \"my-search-link\", 
             repoOrViewName: \"humio\", 
             isLive: true, openInNewTab: true,
             useWidgetTimeWindow: true,
             queryString: \"#vhost\",
             arguments: [ {key: \"some\", value: \"thing\"} ] }
      } )
  { 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 {
  createSearchLinkInteraction(input:
       { path: \"humio\",
         searchLinkInteractionInput: { 
             name: \"my-search-link\", 
             repoOrViewName: \"humio\", 
             isLive: true, openInNewTab: true,
             useWidgetTimeWindow: true,
             queryString: \"#vhost\",
             arguments: [ {key: \"some\", value: \"thing\"} ] }
      } )
  { 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 {
  createSearchLinkInteraction(input:
       { path: \"humio\",
         searchLinkInteractionInput: { 
             name: \"my-search-link\", 
             repoOrViewName: \"humio\", 
             isLive: true, openInNewTab: true,
             useWidgetTimeWindow: true,
             queryString: \"#vhost\",
             arguments: [ {key: \"some\", value: \"thing\"} ] }
      } )
  { 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": {
    "createSearchLinkInteraction": {
      "id": "TOnSZZwjHm4sGiUrIP1FuUDD38k3wIl1"
    }
  }
}

Given Datatypes

For CreateSearchLinkInteractionInput, there are a few parameters. Below is a list of them:

Table: CreateSearchLinkInteractionInput

Parameter	Type	Required	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 17, 2024
`path`	string	yes	The path for the link.
`searchLinkInteractionInput`	string	yes	The search link. See `SearchLinkInteractionInput`.

Returned Datatypes

As indicated by the syntax above, this mutation will return data using the datatype, InteractionId. Below is the parameter of that datatype:

Table: InteractionId

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 25, 2024
`id`	string	yes	`Long-Term`	The unique identifier for the interaction.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes