group_pipeline_analytics

Gets or lists a group_pipeline_analytics resource.

Overview

Name	group_pipeline_analytics
Type	Resource
Id	gitlab.ci.group_pipeline_analytics

Fields

The following fields are returned by SELECT queries:

get

GraphQL response envelope

Name	Datatype	Description
month_pipelines_labels	array
month_pipelines_successful	array
month_pipelines_totals	array
pipeline_times_labels	array
pipeline_times_values	array
week_pipelines_labels	array
week_pipelines_successful	array
week_pipelines_totals	array
year_pipelines_labels	array
year_pipelines_successful	array
year_pipelines_totals	array

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	full_path, host	from_time, ref, source, to_time	Pipeline analytics. Generated from the GitLab GraphQL schema field Group.pipelineAnalytics (PipelineAnalytics).

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)
from_time	string	Start of the requested time (in UTC). Defaults to the pipelines started in the past week.
ref	string	Branch that triggered the pipeline.
source	string	Source of the pipeline.
to_time	string	End of the requested time (in UTC). Defaults to the pipelines started before the current date.

SELECT examples

get

Pipeline analytics. Generated from the GitLab GraphQL schema field Group.pipelineAnalytics (PipelineAnalytics).

SELECT
month_pipelines_labels,
month_pipelines_successful,
month_pipelines_totals,
pipeline_times_labels,
pipeline_times_values,
week_pipelines_labels,
week_pipelines_successful,
week_pipelines_totals,
year_pipelines_labels,
year_pipelines_successful,
year_pipelines_totals
FROM gitlab.ci.group_pipeline_analytics
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
AND from_time = '{{ from_time }}'
AND ref = '{{ ref }}'
AND source = '{{ source }}'
AND to_time = '{{ to_time }}'
;