group_customizable_dashboard_visualizations
Gets or lists a group_customizable_dashboard_visualizations resource.
Overview​
| Name | group_customizable_dashboard_visualizations |
| Type | Resource |
| Id | gitlab.analytics.group_customizable_dashboard_visualizations |
Fields​
The following fields are returned by SELECT queries:
- list
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
data | string | Data of the visualization. |
errors | array | |
options | string | Options of the visualization. |
slug | string | Slug of the visualization. |
type | string | Type of the visualization. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | full_path, host | slug | Visualizations of the group or associated configuration project. Generated from the GitLab GraphQL schema field Group.customizableDashboardVisualizations (connection of CustomizableDashboardVisualization 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) |
slug | string | Slug of the visualization to return. |
SELECT examples​
- list
Visualizations of the group or associated configuration project. Generated from the GitLab GraphQL schema field Group.customizableDashboardVisualizations (connection of CustomizableDashboardVisualization nodes).
SELECT
data,
errors,
options,
slug,
type
FROM gitlab.analytics.group_customizable_dashboard_visualizations
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND slug = '{{ slug }}'
;