The createDashboardFromPackageTemplate() GraphQL mutation field may be used to create a dashboard in LogScale from a package dashboard template.

For more information on creating dashboards, see the Create Dashboards and Widgets documentation page. You may also want to look at the Packages page.

Packages

Syntax

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

graphql
createDashboardFromPackageTemplate(
      viewName: string!
      packageId: VersionedPackageSpecifier!
      dashboardTemplateName: string!
      overrideName: string
   ): CreateDashboardFromPackageTemplateMutation!

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

Raw
graphql
mutation {
  createDashboardFromPackageTemplate(
        viewName: "humio", packageId: "humio/insights@0.0.14",
        dashboardTemplateName: "Hosts",
        overrideName: "Visitors"
        )
  { dashboard {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 {
  createDashboardFromPackageTemplate(
        viewName: \"humio\", packageId: \"humio/insights@0.0.14\",
        dashboardTemplateName: \"Hosts\",
        overrideName: \"Visitors\"
        )
  { dashboard {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 {
  createDashboardFromPackageTemplate(
        viewName: \"humio\", packageId: \"humio/insights@0.0.14\",
        dashboardTemplateName: \"Hosts\",
        overrideName: \"Visitors\"
        )
  { dashboard {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 { ^
  createDashboardFromPackageTemplate( ^
        viewName: \"humio\", packageId: \"humio/insights@0.0.14\", ^
        dashboardTemplateName: \"Hosts\", ^
        overrideName: \"Visitors\" ^
        ) ^
  { dashboard {id}} ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createDashboardFromPackageTemplate(
        viewName: \"humio\", packageId: \"humio/insights@0.0.14\",
        dashboardTemplateName: \"Hosts\",
        overrideName: \"Visitors\"
        )
  { dashboard {id}}
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  createDashboardFromPackageTemplate(
        viewName: \"humio\", packageId: \"humio/insights@0.0.14\",
        dashboardTemplateName: \"Hosts\",
        overrideName: \"Visitors\"
        )
  { dashboard {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
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  createDashboardFromPackageTemplate(
        viewName: \"humio\", packageId: \"humio/insights@0.0.14\",
        dashboardTemplateName: \"Hosts\",
        overrideName: \"Visitors\"
        )
  { dashboard {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 {
  createDashboardFromPackageTemplate(
        viewName: \"humio\", packageId: \"humio/insights@0.0.14\",
        dashboardTemplateName: \"Hosts\",
        overrideName: \"Visitors\"
        )
  { dashboard {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
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "createDashboardFromPackageTemplate": {
      "dashboard": {
        "id": "zIcLigwHclBRJKfGn8PXxH1Pw6mJZtoY"
      }
    }
  }
}

Given and Returned Datatypes

The given datatype VersionedPackageSpecifier is a scalar value. For it, you would put the package name, followed by an ampersand and then the version number. The returned datatype CreateDashboardFromPackageTemplateMutation has only one parameter, but the datatype for it includes many sub-parameters. Click on it to see them.

Table: CreateDashboardFromPackageTemplateMutation

ParameterTypeRequiredDefaultDescription
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 24, 2024
DashboardDashboardyes The dashboard to create from the package template. See Dashboard.