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

There are several other basic mutations related to dashboards. You can use copyDashboard() to clone an existing dashboard, and updateDashboard() to update a dashboard. The renameDashboard() is used to rename a dashboard and deleteDashboardV3() to delete one. To get a list of dashboards, use the dashboardsPage() query.

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.

API Stability Long-Term

Syntax

graphql
createDashboard(
      input: CreateDashboardInput!
   ): CreateDashboardMutation!

Example

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',
  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": "abc123"
      }
    }
  }
}

Given Datatype

For this input datatype, you would provide the name of the search domain to associate the dashboard, a list of widgets to include in the dashboard, any filters and labels, and a few other factors. These are listed and explained, along with other parameters, in the table below:

Table: CreateDashboardInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
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 Datatype

For the returned datatype, there are several sub-parameters related to the dashboard (see second table below). Since you will have created the dashboard with this mutation, you may only want to get the unique identifier generated for it to use with other mutations and queries.

Table: CreateDashboardMutation

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Mar 25, 2025
dashboardDashboardyes Long-TermThe dashboard to create. See Dashboard.

The table below contains the parameters of the sub-datatype used by the only parameter of the datatype shown above.

Table: Dashboard

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Aug 19, 2025
allowedActions[AssetAction]yes Short-TermThe allowed asset actions. See AssetAction Table). This is feature is a preview and may be changed.
createdInfoAssetCommitMetadata  Long-TermMetadata related to the creation of the dashboard. See AssetCommitMetadata.
defaultFilterDashboardFilter  Long-TermThe default filter used with the dashboard (see DashboardFilter Table).
defaultSharedTimeEnabledbooleanyes Long-TermWhether the shared time by default is enabled.
defaultSharedTimeEndstringyes Long-TermThe default shared ending time.
defaultSharedTimeStartstringyes Long-TermThe default shared starting time.
descriptionstring  Long-TermA description of the dashboard.
displayNamestringyes Long-TermThe display name of the dashboard.
filters[DashboardFilter]yes Long-TermThe filters used with the dashboard. See DashboardFilter.
idstringyes Long-TermThe unique identifier for the dashboard.
isStarredbooleanyes Long-TermWhether the dashboard is marked with a star.
labels[string]yes Long-TermAny labels associated with the dashboard.
modifiedInfoAssetCommitMetadata  Long-TermMetadata related to the latest modification of the dashboard. See AssetCommitMetadata.
namestringyes Long-TermThe name of the dashboard.
packagePackageInstallationyes Long-TermThe package, if there is one, in which the dashboard is included (see PackageInstallation Table).
packageIdVersionedPackageSpecifieryes Long-TermThe unique identifiers of the package. VersionedPackageSpecifier is a scalar.
parameters[DashboardParameter]yes Long-TermList of dashboard parameters (see DashboardParameter Table).
readOnlyTokens[DashboardLink]yes Long-TermList of tokens used to access the dashboard without logging in. Useful for wall mounted dashboards or public dashboards. See DashboardLink.
resourcestringyes Short-TermThe resource identifier for this dashboard.
searchDomainSearchDomainyes Long-TermThe search domain for the dashboard. See SearchDomain.
sections[Section]yes Long-TermThe sections for the dashboard. See Section.
series[SeriesConfig]yes Long-TermThe series configuration for the dashboard. See SeriesConfig.
templateYamlstringyes DeprecatedA yaml formatted string that describes the dashboard. This field has been replaced with yamlTemplate. It will be removed at the earliest in version 1.225.
timeJumpSizeInMsinteger  Long-TermThe skip time in milliseconds for the dashboard.
updateFrequencyDashboardUpdateFrequencyTypeyes Long-TermThe frequency in which dashboard is updated. See DashboardUpdateFrequencyType, and the explanations under the DashboardParameter.
widgets[Widget]yes Long-TermWidgets for the dashboard (see Widget Table).
yamlTemplateYAMLyes Long-TermA yaml formatted string that describes the dashboard. YAML is a scalar. It doesn't contain links or permissions, and is safe to share and use for making copies of a dashboard. This replaced templateYaml starting in LogScale version 1.165.