🎯API Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The createDashboardLinkInteraction() mutation creates a dashboard link interaction in a repository or view. A dashboard link interaction makes field values in dashboard widgets into clickable links that navigate to a specified target dashboard. When a user selects a field value that matches the configured field conditions, LogScale activates the link. You can configure the interaction to pass the triggering widget's time range to the target dashboard and to open the target in a new browser tab.

Syntax

graphql
createDashboardLinkInteraction(
      input: CreateDashboardLinkInteractionInput!
   ): InteractionId!

The mutation accepts a single required input argument of type CreateDashboardLinkInteractionInput. path identifies the repository or view that owns the interaction. dashboardLinkInteractionInput provides the full interaction definition, including the target dashboard reference, field conditions, and display options.

Example

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

Input Parameters

The top-level input type is CreateDashboardLinkInteractionInput. Its dashboardLinkInteractionInput field contains the full definition, including the target dashboard reference, field conditions, and display options. The following table lists all fields and links to sub-parameter types.

Table: CreateDashboardLinkInteractionInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
dashboardLinkInteractionInputDashboardLinkInteractionInputyes Long-Term The dashboard link to create. See DashboardLinkInteractionInput.
pathStringyes Long-Term The path of the dashboard link.

Returned Values

The mutation returns an InteractionId object containing the unique identifier of the new interaction. Store this identifier to use with updateDashboardLinkInteraction() or deleteInteractionV2().

Table: InteractionId Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
idStringyes Long-Term The unique identifier for the interaction.