Summary

The createDashboardLinkInteraction() GraphQL mutation field is used to create a dashboard link interaction.

API Stability Long-Term

Syntax

graphql
createDashboardLinkInteraction(
       input: CreateDashboardLinkInteractionInput!
    ): InteractionId!

For the input, you'll need to give the name of the dashboard link interaction, a list of interaction conditions (i.e., fields and arguments), etc. See the Input Parameters section for details.

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

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

For the input, you would provide the name of the dashboard link interaction to create, a list of interaction conditions (i.e., fields and their arguments), and other parameters. These are listed in the table below, along with links to sub-parameters used:

Table: CreateDashboardLinkInteractionInput 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 17, 2024
dashboardLinkInteractionInputDashboardLinkInteractionInputyes Long-TermThe dashboard link to create. See DashboardLinkInteractionInput.
pathstringyes Long-TermThe path of the dashboard link.

Returned Values

For the results, you can only get 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.