API Stability Long-Term

The updateCustomLinkInteraction() GraphQL mutation may be used to update a custom link interaction in LogScale.

Syntax

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

graphql
updateCustomLinkInteraction(
      input: UpdateCustomLinkInteractionInput!
   ): InteractionId!

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

Raw
graphql
mutation {
  updateCustomLinkInteraction( input:
    {
      path: "humio",
      interactionId: "abc123",
      customLinkInteractionInput: { name: "our-link",
                                    urlTemplate: "https://company.com?q={{ fields.myField }}",
                                    openInNewTab: false }
    }
  )
  { 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 {
  updateCustomLinkInteraction( input:
    {
      path: \"humio\",
      interactionId: \"abc123\",
      customLinkInteractionInput: { name: \"our-link\",
                                    urlTemplate: \"https://company.com?q={{ fields.myField }}\",
                                    openInNewTab: false }
    }
  )
  { 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 {
  updateCustomLinkInteraction( input:
    {
      path: \"humio\",
      interactionId: \"abc123\",
      customLinkInteractionInput: { name: \"our-link\",
                                    urlTemplate: \"https://company.com?q={{ fields.myField }}\",
                                    openInNewTab: false }
    }
  )
  { 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 { ^
  updateCustomLinkInteraction( input: ^
    { ^
      path: \"humio\", ^
      interactionId: \"abc123\", ^
      customLinkInteractionInput: { name: \"our-link\", ^
                                    urlTemplate: \"https://company.com?q={{ fields.myField }}\", ^
                                    openInNewTab: false } ^
    } ^
  ) ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateCustomLinkInteraction( input:
    {
      path: \"humio\",
      interactionId: \"abc123\",
      customLinkInteractionInput: { name: \"our-link\",
                                    urlTemplate: \"https://company.com?q={{ fields.myField }}\",
                                    openInNewTab: false }
    }
  )
  { 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 {
  updateCustomLinkInteraction( input:
    {
      path: \"humio\",
      interactionId: \"abc123\",
      customLinkInteractionInput: { name: \"our-link\",
                                    urlTemplate: \"https://company.com?q={{ fields.myField }}\",
                                    openInNewTab: false }
    }
  )
  { 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 {
  updateCustomLinkInteraction( input:
    {
      path: \"humio\",
      interactionId: \"abc123\",
      customLinkInteractionInput: { name: \"our-link\",
                                    urlTemplate: \"https://company.com?q={{ fields.myField }}\",
                                    openInNewTab: false }
    }
  )
  { 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 {
  updateCustomLinkInteraction( input:
    {
      path: \"humio\",
      interactionId: \"abc123\",
      customLinkInteractionInput: { name: \"our-link\",
                                    urlTemplate: \"https://company.com?q={{ fields.myField }}\",
                                    openInNewTab: false }
    }
  )
  { 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
{
  "updateCustomLinkInteraction": {
    "id": "abc123"
    }
  }
}

Given Datatypes

For UpdateCustomLinkInteractionInput, there are a few parameters. Below is a list of them along with a description of each:

Table: UpdateCustomLinkInteractionInput

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 23, 2024
customLinkInteractionInputCustomLinkInteractionInputyes Long-TermThe custom link for interactions. See CustomLinkInteractionInput.
interactionIdstringyes Long-TermThe unique identifier of the interactions.
pathstringyes Long-TermThe path to the custom link.

Returned Datatypes

The returned datatype InteractionId has one parameter. Below is a description of it:

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.