custom_dashboard

Gets or lists a custom_dashboard resource.

Overview

Name	custom_dashboard
Type	Resource
Id	gitlab.analytics.custom_dashboard

Fields

The following fields are returned by SELECT queries:

get

GraphQL response envelope

Name	Datatype	Description
id	string	Global ID of the custom dashboard.
name	string	Display name of the dashboard.
config	string	Dashboard layout and widget configuration.
created_at	string	Timestamp when the dashboard was created.
description	string	Optional summary or purpose of the dashboard.
lock_version	integer	Version used for optimistic concurrency control.
namespace	object	Namespace identity (id, full_path, name)
project	object	Project identity (id, full_path, name)
slug	string	Dashboard url slug.
system	boolean	Whether the dashboard is a built-in GitLab dashboard.
updated_at	string	Timestamp when the dashboard was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, host		Find a custom dashboard by ID. Generated from the GitLab GraphQL schema field Query.customDashboard (CustomDashboard).

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
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)
id	string	Dashboard ID.

SELECT examples

get

Find a custom dashboard by ID. Generated from the GitLab GraphQL schema field Query.customDashboard (CustomDashboard).

SELECT
id,
name,
config,
created_at,
description,
lock_version,
namespace,
project,
slug,
system,
updated_at
FROM gitlab.analytics.custom_dashboard
WHERE id = '{{ id }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;