updateDashboard()

API Stability	`Long-Term`

The updateDashboard() GraphQL mutation may be used to update a dashboard in LogScale.

For more information on dashboards, see the Dashboards & Widgets documentation page.

Syntax

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

graphql

updateDashboard(
      input: UpdateDashboardInput!
   ): UpdateDashboardMutation!

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

Show:

graphql

mutation {
  updateDashboard( input:
    {
      id: "8yHvhPf8GJHDZaP9MRrCSlcvfcbHyInY",
      name: "New Name",
      description: "New Description"
    }
  )
  { dashboard { id } }
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateDashboard( input:
    {
      id: \"8yHvhPf8GJHDZaP9MRrCSlcvfcbHyInY\",
      name: \"New Name\",
      description: \"New Description\"
    }
  )
  { dashboard { id } }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updateDashboard( input:
    {
      id: \"8yHvhPf8GJHDZaP9MRrCSlcvfcbHyInY\",
      name: \"New Name\",
      description: \"New Description\"
    }
  )
  { dashboard { id } }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  updateDashboard( input: ^
    { ^
      id: \"8yHvhPf8GJHDZaP9MRrCSlcvfcbHyInY\", ^
      name: \"New Name\", ^
      description: \"New Description\" ^
    } ^
  ) ^
  { dashboard { id } } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updateDashboard( input:
    {
      id: \"8yHvhPf8GJHDZaP9MRrCSlcvfcbHyInY\",
      name: \"New Name\",
      description: \"New Description\"
    }
  )
  { dashboard { id } }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  updateDashboard( input:
    {
      id: \"8yHvhPf8GJHDZaP9MRrCSlcvfcbHyInY\",
      name: \"New Name\",
      description: \"New Description\"
    }
  )
  { 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

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  updateDashboard( input:
    {
      id: \"8yHvhPf8GJHDZaP9MRrCSlcvfcbHyInY\",
      name: \"New Name\",
      description: \"New Description\"
    }
  )
  { dashboard { id } }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  updateDashboard( input:
    {
      id: \"8yHvhPf8GJHDZaP9MRrCSlcvfcbHyInY\",
      name: \"New Name\",
      description: \"New Description\"
    }
  )
  { 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

Show:

json

{
  "data": {
    "updateDashboard": {
      "dashboard": {
        "id": "8yHvhPf8GJHDZaP9MRrCSlcvfcbHyInY"
      }
    }
  }
}

Given Datatypes

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

Table: UpdateDashboardInput

Parameter	Type	Required	Description
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 23, 2024
`defaultFilterId`	string		The unique identifier for the default filter.
`defaultSharedTimeEnabled`	boolean		Whether the default shared time is enabled.
`defaultSharedTimeEnd`	string		The updated default shared time end for the dashboard.
`defaultSharedTimeStart`	string		The updated default shared time start for the dashboard.
`description`	string		An updated description of the dashboard.
`filters`	[`FilterInput`]	yes	The filters for the dashboard. See `FilterInput`.
`id`	string	yes	The unique identifier of the dashboard to update.
`labels`	[string]	yes	The labels for the dashboard being updated.
`links`	[`LinkInput`]	yes	All dashboard links. See `LinkInput`.
`name`	string		The name of the dashboard to update.
`parameters`	[`ParameterInput`]	yes	The dashboard parameters. See `ParameterInput`.
`timeJumpSizeInMs`	integer		The skip time in milliseconds for the dashboard.
`updateFrequency`	`DashboardUpdateFrequencyInput`		The frequency in which the dashboard is to be updated. See `DashboardUpdateFrequencyInput`.
`widgets`	[`WidgetInput`]	yes	The dashboards widgets. See `WidgetInput`.

Returned Datatypes

The returned datatype UpdateDashboardMutation has one parameter, but many sub-parameters. Click on the link below for the one parameter to see the table with the sub-parameters:

Table: UpdateDashboardMutation

Parameter	Type	Required	Stability	Description
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: Oct 4, 2024
`dashboard`	`Dashboard`	yes	`Long-Term`	The dashboard to update. See `Dashboard`.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes