Summary

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

API Stability Long-Term

Syntax

graphql
updateDashboardLinkInteraction(
      input: UpdateDashboardLinkInteractionInput!
   ): InteractionId!

For the input, you'll have to give the unique identifier of the interaction, and any arguments for the dashboard link, and other values to update. See the Input Parameters section for specifics.

For the results, you'll receive only the identifier of the interaction link. See the Returned Values section.

Example

Raw
graphql
mutation {
  updateDashboardLinkInteraction( input:
    {
      path: "humio",
      interactionId: "abc123",
      dashboardLinkInteractionInput: { name: "our-dash-link",
                                       arguments: [ {key: "some", value: "thing"} ],
                                       openInNewTab: false,
                                       useWidgetTimeWindow: true }
    }
  )
  { 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 {
  updateDashboardLinkInteraction( input:
    {
      path: \"humio\",
      interactionId: \"abc123\",
      dashboardLinkInteractionInput: { name: \"our-dash-link\",
                                       arguments: [ {key: \"some\", value: \"thing\"} ],
                                       openInNewTab: false,
                                       useWidgetTimeWindow: true }
    }
  )
  { 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 {
  updateDashboardLinkInteraction( input:
    {
      path: \"humio\",
      interactionId: \"abc123\",
      dashboardLinkInteractionInput: { name: \"our-dash-link\",
                                       arguments: [ {key: \"some\", value: \"thing\"} ],
                                       openInNewTab: false,
                                       useWidgetTimeWindow: true }
    }
  )
  { 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 { ^
  updateDashboardLinkInteraction( input: ^
    { ^
      path: \"humio\", ^
      interactionId: \"abc123\", ^
      dashboardLinkInteractionInput: { name: \"our-dash-link\", ^
                                       arguments: [ {key: \"some\", value: \"thing\"} ], ^
                                       openInNewTab: false, ^
                                       useWidgetTimeWindow: true } ^
    } ^
  ) ^
  { id } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateDashboardLinkInteraction( input:
    {
      path: \"humio\",
      interactionId: \"abc123\",
      dashboardLinkInteractionInput: { name: \"our-dash-link\",
                                       arguments: [ {key: \"some\", value: \"thing\"} ],
                                       openInNewTab: false,
                                       useWidgetTimeWindow: true }
    }
  )
  { 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 {
  updateDashboardLinkInteraction( input:
    {
      path: \"humio\",
      interactionId: \"abc123\",
      dashboardLinkInteractionInput: { name: \"our-dash-link\",
                                       arguments: [ {key: \"some\", value: \"thing\"} ],
                                       openInNewTab: false,
                                       useWidgetTimeWindow: true }
    }
  )
  { 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 {
  updateDashboardLinkInteraction( input:
    {
      path: \"humio\",
      interactionId: \"abc123\",
      dashboardLinkInteractionInput: { name: \"our-dash-link\",
                                       arguments: [ {key: \"some\", value: \"thing\"} ],
                                       openInNewTab: false,
                                       useWidgetTimeWindow: true }
    }
  )
  { 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 {
  updateDashboardLinkInteraction( input:
    {
      path: \"humio\",
      interactionId: \"abc123\",
      dashboardLinkInteractionInput: { name: \"our-dash-link\",
                                       arguments: [ {key: \"some\", value: \"thing\"} ],
                                       openInNewTab: false,
                                       useWidgetTimeWindow: true }
    }
  )
  { 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
{
  "updateDashboardLinkInteraction": {
    "id": "abc123"
    }
  }
}

Input Parameters

For the input, you would provide the unique identifier of the interaction, and through sub-parameters, any arguments for the dashboard link, and other values to update. These are listed in the table below, along with links to the sub-parameters:

Table: UpdateDashboardLinkInteractionInput Input Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 23, 2024
dashboardLinkInteractionInputDashboardLinkInteractionInputyes Long-TermThe dashboard link for interactions. See DashboardLinkInteractionInput.
interactionIdstringyes Long-TermThe unique identifier of the interaction.
pathstringyes Long-TermThe path of the interaction.

Returned Values

The only returned value is the unique identifier of the interaction link. The table below provide a little more details:

Table: InteractionId Datatype

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Sep 25, 2024
idstringyes Long-TermThe unique identifier for the interaction.