group_customizable_dashboards

Gets or lists a group_customizable_dashboards resource.

Overview

Name	group_customizable_dashboards
Type	Resource
Id	gitlab.analytics.group_customizable_dashboards

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
category	string	Category of dashboard. (ANALYTICS)
description	string	Description of the dashboard.
errors	array
filters	string	Dashboard global filters.
slug	string	Slug of the dashboard.
title	string	Title of the dashboard.
user_defined	boolean	Indicates whether the dashboard is user-defined or provided by GitLab.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	full_path, host	category, slug	Customizable dashboards for the group. Generated from the GitLab GraphQL schema field Group.customizableDashboards (connection of CustomizableDashboard nodes).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
full_path	string	Full path of the group, for example gitlab-org
host	string	GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST)
category	string	Find by dashboard type.
slug	string	Find by dashboard slug.

SELECT examples

list

Customizable dashboards for the group. Generated from the GitLab GraphQL schema field Group.customizableDashboards (connection of CustomizableDashboard nodes).

SELECT
category,
description,
errors,
filters,
slug,
title,
user_defined
FROM gitlab.analytics.group_customizable_dashboards
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND category = '{{ category }}'
AND slug = '{{ slug }}'
;