API Stability Long-Term

The createDashboard() GraphQL mutation may be used to create a dashboard in LogScale.

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

Syntax

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

graphql
createDashboard(
      input: CreateDashboardInput!
   ): CreateDashboardMutation!

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

Raw
graphql
mutation {
  createDashboard(input:
        { searchDomainName: "humio", 
          name: "my-dashboard",
        } )
  { 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 {
  createDashboard(input:
        { searchDomainName: \"humio\", 
          name: \"my-dashboard\",
        } )
  { 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 {
  createDashboard(input:
        { searchDomainName: \"humio\", 
          name: \"my-dashboard\",
        } )
  { 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 { ^
  createDashboard(input: ^
        { searchDomainName: \"humio\",  ^
          name: \"my-dashboard\", ^
        } ) ^
  { dashboard {id }} ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  createDashboard(input:
        { searchDomainName: \"humio\", 
          name: \"my-dashboard\",
        } )
  { dashboard {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 {
  createDashboard(input:
        { searchDomainName: \"humio\", 
          name: \"my-dashboard\",
        } )
  { dashboard {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 {
  createDashboard(input:
        { searchDomainName: \"humio\", 
          name: \"my-dashboard\",
        } )
  { 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 {
  createDashboard(input:
        { searchDomainName: \"humio\", 
          name: \"my-dashboard\",
        } )
  { 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": {
    "createDashboard": {
      "dashboard": {
        "id": "r85CDJn6cfMIVeCPfXHEriM1CB93SD5O"
      }
    }
  }
}

Given Datatypes

For CreateDashboardInput, there are several parameters that may be given. Below is a list of them along with descriptions of each:

Table: CreateDashboardInput

ParameterTypeRequiredDefaultStabilityDescription
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 17, 2024
defaultFilterIdstring  Long-TermThe unique identifier for the default filter.
descriptionstring  Long-TermA description of the dashboard.
filters[FilterInput]yes Long-TermA list of filters to use with the dashboard. See FilterInput.
labels[string]yes Long-TermA list of labels to use with the dashboard.
links[LinkInput]yes Long-TermA list of links for the dashboard. See LinkInput.
namestringyes Long-TermThe name of the dashboard to create.
parameters[ParameterInput]yes Long-TermA list of parameters to use with the dashboard. See ParameterInput.
searchDomainNamestringyes Long-TermThe name of the search domain associated with the dashboard to create.
sections[SectionInput]yes Long-TermA list of sections to use with the dashboard. See SectionInput.
updateFrequencyDashboardUpdateFrequencyInputyes Long-TermThe frequency with which to update the dashboard. See DashboardUpdateFrequencyInput.
widgets[WidgetInput]yes Long-TermThe widgets to include in the dashboard. See WidgetInput.

Returned Datatypes

For CreateDashboardMutation there's only one parameter, but with a datatype that has many parameters and sub-parameters of its own. Click on the datatype for this one parameter in the table below to see them:

Table: CreateDashboardMutation

ParameterTypeRequiredDefaultStabilityDescription
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: Mar 25, 2025
dashboardDashboardyes Long-TermThe dashboard to create. See Dashboard.