starredDashboards()

API Stability	`Long-Term`

The starredDashboards() GraphQL query returns a list of starred dashboards.

For more information on dashboards, see the Dashboards & Widgets documentation page. You may also want to look at the Dashboards page in the Training section.

Syntax

Below is the syntax for the starredDashboards() query field:

graphql

starredDashboards: [Dashboard!]!

For the datatype Dashboard(), you'll have to specify which values you want. Below is an example with a few values requested:

Show:

graphql

query {
	starredDashboards {
	  searchDomain { id, name },
      id, name, 
      widgets { id, title, description }
	}
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
	starredDashboards {
	  searchDomain { id, name },
      id, name, 
      widgets { id, title, description }
	}
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
	starredDashboards {
	  searchDomain { id, name },
      id, name, 
      widgets { id, title, description }
	}
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "query { ^
	starredDashboards { ^
	  searchDomain { id, name }, ^
      id, name,  ^
      widgets { id, title, description } ^
	} ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
	starredDashboards {
	  searchDomain { id, name },
      id, name, 
      widgets { id, title, description }
	}
}"
}'
    "$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" : "query {
	starredDashboards {
	  searchDomain { id, name },
      id, name, 
      widgets { id, title, description }
	}
}"
}';
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" : "query {
	starredDashboards {
	  searchDomain { id, name },
      id, name, 
      widgets { id, title, description }
	}
}"
}'''

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" : "query {
	starredDashboards {
	  searchDomain { id, name },
      id, name, 
      widgets { id, title, description }
	}
}"
}
);


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": {
    "starredDashboards": [
      {
        "searchDomain": {
          "id": "8jrdOlq4RgWGHsr8C70jkT7M",
          "name": "humio"
        },
        "id": "pG66nq5ajCqRw6YrVcafMXtHy9DBKkBC",
        "name": "Errors",
        "widgets": [
          {
            "id": "7a9e760e-4944-41e7-909f-a13bc550c821",
            "title": "Standard Alerts With Other Errors",
            "description": "Standard alerts with errors not from invoking actions."
          },
          {
            "id": "1dddce1b-289d-4672-9182-dba9c097587b",
            "title": "Slow Warnings",
            "description": null
          }
        ]
      }
    ]
  }
}

In the example here, it requests information on all dashboards that have been starred. First, the id and name is requested on the search domain for each starred dashboard. In this case, since there is only one starred dashboard, there's only one search domain — and information on that one dashboard.

Next, the id, name, and list of widgets is requested. For each widget, the id, title, and description of each of those. This is all done with nesting of parameters with commas and curly-brackets.

Given Datatypes

For the given datatype, Dashboard, there are several parameters. Below is a list of them along with their datatypes and a description of each. For some, like widgets, you'll have to drill down to the pages for the parameters of them — as shown in the example above.

Table: Dashboard

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: Mar 28, 2025
`allowedActions`	[`AssetAction`]	yes	`Preview`	The allowed asset actions. See `AssetAction` Table). This is feature is a preview and may be changed.
`defaultFilter`	`DashboardFilter`		`Long-Term`	The default filter used with the dashboard (see `DashboardFilter` Table).
`defaultSharedTimeEnabled`	boolean	yes	`Long-Term`	Whether the shared time by default is enabled.
`defaultSharedTimeEnd`	string	yes	`Long-Term`	The default shared ending time.
`defaultSharedTimeStart`	string	yes	`Long-Term`	The default shared starting time.
`description`	string		`Long-Term`	A description of the dashboard.
`displayName`	string	yes	`Long-Term`	The display name of the dashboard.
`filters`	[`DashboardFilter`]	yes	`Long-Term`	The filters used with the dashboard. See `DashboardFilter`.
`id`	string	yes	`Long-Term`	The unique identifier for the dashboard.
`isStarred`	boolean	yes	`Long-Term`	Whether the dashboard is marked with a star.
`labels`	[string]	yes	`Long-Term`	Any labels associated with the dashboard.
`name`	string	yes	`Long-Term`	The name of the dashboard.
`package`	`PackageInstallation`	yes	`Long-Term`	The package, if there is one, in which the dashboard is included (see `PackageInstallation` Table).
`packageId`	`VersionedPackageSpecifier`	yes	`Long-Term`	The unique identifiers of the package. `VersionedPackageSpecifier` is a scalar.
`parameters`	[`DashboardParameter`]	yes	`Long-Term`	List of dashboard parameters (see `DashboardParameter` Table).
`readOnlyTokens`	[`DashboardLink`]	yes	`Long-Term`	List of tokens used to access the dashboard without logging in. Useful for wall mounted dashboards or public dashboards. See `DashboardLink`.
`resource`	string	yes	`Short-Term`	The resource identifier for this dashboard.
`searchDomain`	`SearchDomain`	yes	`Long-Term`	The search domain for the dashboard. See `SearchDomain`.
`sections`	[`Section`]	yes	`Long-Term`	The sections for the dashboard. See `Section`.
`yamlTemplate`	string	yes	`Long-Term`	A YAML formatted string that describes the dashboard. It does not 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.
`timeJumpSizeInMs`	integer		`Long-Term`	The skip time in milliseconds for the dashboard.
`updateFrequency`	`DashboardUpdateFrequencyType`	yes	`Long-Term`	The frequency in which dashboard is updated. See the explanations under the `DashboardParameter`.
`widgets`	[`Widget`]	yes	`Long-Term`	Widgets for the dashboard (see `Widget` Table).

GraphQL Queries

GraphQL API Stability

GraphQL Mutations

GraphQL Datatypes