--- title: Aggregate pipelines events description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > CI Visibility Pipelines --- # Aggregate pipelines events{% #aggregate-pipelines-events %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/ci/pipelines/analytics/aggregate | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/ci/pipelines/analytics/aggregate | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/ci/pipelines/analytics/aggregate | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/ci/pipelines/analytics/aggregate | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/ci/pipelines/analytics/aggregate | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/ci/pipelines/analytics/aggregate | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/ci/pipelines/analytics/aggregate | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/ci/pipelines/analytics/aggregate | ### Overview Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries. This endpoint requires the `ci_visibility_read` permission. OAuth apps require the `ci_visibility_read` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#ci-visibility-pipelines) to access this endpoint. ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ----------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | | compute | [object] | The list of metrics or timeseries to compute for the retrieved buckets. | | compute | aggregation [*required*] | enum | An aggregation function. Allowed enum values: `count,cardinality,pc75,pc90,pc95,pc98,pc99,sum,min,max` | | compute | interval | string | The time buckets' size (only used for type=timeseries) Defaults to a resolution of 150 points. | | compute | metric | string | The metric to use. | | compute | type | enum | The type of compute. Allowed enum values: `timeseries,total` | | | filter | object | The search and filter query settings. | | filter | from | string | The minimum time for the requested events; supports date, math, and regular timestamps (in milliseconds). | | filter | query | string | The search query following the CI Visibility Explorer search syntax. | | filter | to | string | The maximum time for the requested events, supports date, math, and regular timestamps (in milliseconds). | | | group_by | [object] | The rules for the group-by. | | group_by | facet [*required*] | string | The name of the facet to use (required). | | group_by | histogram | object | Used to perform a histogram computation (only for measure facets). At most, 100 buckets are allowed, the number of buckets is `(max - min)/interval`. | | histogram | interval [*required*] | double | The bin size of the histogram buckets. | | histogram | max [*required*] | double | The maximum value for the measure used in the histogram (values greater than this one are filtered out). | | histogram | min [*required*] | double | The minimum value for the measure used in the histogram (values smaller than this one are filtered out). | | group_by | limit | int64 | The maximum buckets to return for this group-by. | | group_by | missing | | The value to use for logs that don't have the facet used to group-by. | | missing | Option 1 | string | The missing value to use if there is a string valued facet. | | missing | Option 2 | double | The missing value to use if there is a number valued facet. | | group_by | sort | object | A sort rule. The `aggregation` field is required when `type` is `measure`. | | sort | aggregation | enum | An aggregation function. Allowed enum values: `count,cardinality,pc75,pc90,pc95,pc98,pc99,sum,min,max` | | sort | metric | string | The metric to sort by (only used for `type=measure`). | | sort | order | enum | The order to use, ascending or descending. Allowed enum values: `asc,desc` | | sort | type | enum | The type of sorting algorithm. Allowed enum values: `alphabetical,measure` | | group_by | total | | A resulting object to put the given computes in over all the matching records. | | total | Option 1 | boolean | If set to true, creates an additional bucket labeled "$facet_total". | | total | Option 2 | string | A string to use as the key value for the total bucket. | | total | Option 3 | double | A number to use as the key value for the total bucket. | | | options | object | Global query options that are used during the query. Only supply timezone or time offset, not both. Otherwise, the query fails. | | options | time_offset | int64 | The time offset (in seconds) to apply to the query. | | options | timezone | string | The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York). | {% /tab %} {% tab title="Example" %} ```json { "compute": [ { "aggregation": "pc90", "metric": "@duration", "type": "total" } ], "filter": { "from": "now-15m", "query": "@ci.provider.name:(gitlab OR github)", "to": "now" }, "group_by": [ { "facet": "@ci.status", "limit": 10, "total": false } ], "options": { "timezone": "GMT" } } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} The response object for the pipeline events aggregate API endpoint. | Parent field | Field | Type | Description | | -------------------- | ---------- | ------------- | ---------------------------------------------------------------------------------------------------------------------- | | | data | object | The query results. | | data | buckets | [object] | The list of matching buckets, one item per bucket. | | buckets | by | object | The key-value pairs for each group-by. | | additionalProperties | | | The values for each group-by. | | buckets | computes | object | A map of the metric name to value for regular compute, or a list of values for a timeseries. | | additionalProperties | | | A bucket value, can either be a timeseries or a single value. | | | Option 1 | string | A single string value. | | | Option 2 | double | A single number value. | | | Option 3 | [object] | A timeseries array. | | Option 3 | time | date-time | The time value for this point. | | Option 3 | value | double | The value for this point. | | | links | object | Links attributes. | | links | next | string | Link for the next set of results. The request can also be made using the POST endpoint. | | | meta | object | The metadata associated with a request. | | meta | elapsed | int64 | The time elapsed in milliseconds. | | meta | request_id | string | The identifier of the request. | | meta | status | enum | The status of the response. Allowed enum values: `done,timeout` | | meta | warnings | [object] | A list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response. | | warnings | code | string | A unique code for this type of warning. | | warnings | detail | string | A detailed explanation of this specific warning. | | warnings | title | string | A short human-readable summary of the warning. | {% /tab %} {% tab title="Example" %} ```json { "data": { "buckets": [ { "by": { "": "undefined" }, "computes": { "": { "description": "undefined", "type": "undefined" } } } ] }, "links": { "next": "https://app.datadoghq.com/api/v2/ci/tests/events?filter[query]=foo\u0026page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" }, "meta": { "elapsed": 132, "request_id": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", "status": "done", "warnings": [ { "code": "unknown_index", "detail": "indexes: foo, bar", "title": "One or several indexes are missing or invalid, results hold data from the other indexes" } ] } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Not Authorized {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Curl command curl -X POST "https://api.datadoghq.com/api/v2/ci/pipelines/analytics/aggregate" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "compute": [ { "aggregation": "pc90", "interval": "5m", "metric": "@duration", "type": "timeseries" } ], "filter": { "from": "now-15m", "query": "@ci.provider.name:github AND @ci.status:error", "to": "now" }, "group_by": [ { "facet": "@ci.status", "histogram": { "interval": 10, "max": 100, "min": 50 }, "sort": { "aggregation": "count", "order": "asc" } } ], "options": { "timezone": "GMT" } } EOF ##### ```go // Aggregate pipelines events returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { body := datadogV2.CIAppPipelinesAggregateRequest{ Compute: []datadogV2.CIAppCompute{ { Aggregation: datadogV2.CIAPPAGGREGATIONFUNCTION_PERCENTILE_90, Metric: datadog.PtrString("@duration"), Type: datadogV2.CIAPPCOMPUTETYPE_TOTAL.Ptr(), }, }, Filter: &datadogV2.CIAppPipelinesQueryFilter{ From: datadog.PtrString("now-15m"), Query: datadog.PtrString("@ci.provider.name:(gitlab OR github)"), To: datadog.PtrString("now"), }, GroupBy: []datadogV2.CIAppPipelinesGroupBy{ { Facet: "@ci.status", Limit: datadog.PtrInt64(10), Total: &datadogV2.CIAppGroupByTotal{ CIAppGroupByTotalBoolean: datadog.PtrBool(false)}, }, }, Options: &datadogV2.CIAppQueryOptions{ Timezone: datadog.PtrString("GMT"), }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewCIVisibilityPipelinesApi(apiClient) resp, r, err := api.AggregateCIAppPipelineEvents(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `CIVisibilityPipelinesApi.AggregateCIAppPipelineEvents`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `CIVisibilityPipelinesApi.AggregateCIAppPipelineEvents`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Aggregate pipelines events returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.CiVisibilityPipelinesApi; import com.datadog.api.client.v2.model.CIAppAggregationFunction; import com.datadog.api.client.v2.model.CIAppCompute; import com.datadog.api.client.v2.model.CIAppComputeType; import com.datadog.api.client.v2.model.CIAppGroupByTotal; import com.datadog.api.client.v2.model.CIAppPipelinesAggregateRequest; import com.datadog.api.client.v2.model.CIAppPipelinesAnalyticsAggregateResponse; import com.datadog.api.client.v2.model.CIAppPipelinesGroupBy; import com.datadog.api.client.v2.model.CIAppPipelinesQueryFilter; import com.datadog.api.client.v2.model.CIAppQueryOptions; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); CiVisibilityPipelinesApi apiInstance = new CiVisibilityPipelinesApi(defaultClient); CIAppPipelinesAggregateRequest body = new CIAppPipelinesAggregateRequest() .compute( Collections.singletonList( new CIAppCompute() .aggregation(CIAppAggregationFunction.PERCENTILE_90) .metric("@duration") .type(CIAppComputeType.TOTAL))) .filter( new CIAppPipelinesQueryFilter() .from("now-15m") .query("@ci.provider.name:(gitlab OR github)") .to("now")) .groupBy( Collections.singletonList( new CIAppPipelinesGroupBy() .facet("@ci.status") .limit(10L) .total(new CIAppGroupByTotal(false)))) .options(new CIAppQueryOptions().timezone("GMT")); try { CIAppPipelinesAnalyticsAggregateResponse result = apiInstance.aggregateCIAppPipelineEvents(body); System.out.println(result); } catch (ApiException e) { System.err.println( "Exception when calling CiVisibilityPipelinesApi#aggregateCIAppPipelineEvents"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python """ Aggregate pipelines events returns "OK" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.ci_visibility_pipelines_api import CIVisibilityPipelinesApi from datadog_api_client.v2.model.ci_app_aggregation_function import CIAppAggregationFunction from datadog_api_client.v2.model.ci_app_compute import CIAppCompute from datadog_api_client.v2.model.ci_app_compute_type import CIAppComputeType from datadog_api_client.v2.model.ci_app_pipelines_aggregate_request import CIAppPipelinesAggregateRequest from datadog_api_client.v2.model.ci_app_pipelines_group_by import CIAppPipelinesGroupBy from datadog_api_client.v2.model.ci_app_pipelines_query_filter import CIAppPipelinesQueryFilter from datadog_api_client.v2.model.ci_app_query_options import CIAppQueryOptions body = CIAppPipelinesAggregateRequest( compute=[ CIAppCompute( aggregation=CIAppAggregationFunction.PERCENTILE_90, metric="@duration", type=CIAppComputeType.TOTAL, ), ], filter=CIAppPipelinesQueryFilter( _from="now-15m", query="@ci.provider.name:(gitlab OR github)", to="now", ), group_by=[ CIAppPipelinesGroupBy( facet="@ci.status", limit=10, total=False, ), ], options=CIAppQueryOptions( timezone="GMT", ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = CIVisibilityPipelinesApi(api_client) response = api_instance.aggregate_ci_app_pipeline_events(body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Aggregate pipelines events returns "OK" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::CIVisibilityPipelinesAPI.new body = DatadogAPIClient::V2::CIAppPipelinesAggregateRequest.new({ compute: [ DatadogAPIClient::V2::CIAppCompute.new({ aggregation: DatadogAPIClient::V2::CIAppAggregationFunction::PERCENTILE_90, metric: "@duration", type: DatadogAPIClient::V2::CIAppComputeType::TOTAL, }), ], filter: DatadogAPIClient::V2::CIAppPipelinesQueryFilter.new({ from: "now-15m", query: "@ci.provider.name:(gitlab OR github)", to: "now", }), group_by: [ DatadogAPIClient::V2::CIAppPipelinesGroupBy.new({ facet: "@ci.status", limit: 10, total: false, }), ], options: DatadogAPIClient::V2::CIAppQueryOptions.new({ timezone: "GMT", }), }) p api_instance.aggregate_ci_app_pipeline_events(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Aggregate pipelines events returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_ci_visibility_pipelines::CIVisibilityPipelinesAPI; use datadog_api_client::datadogV2::model::CIAppAggregationFunction; use datadog_api_client::datadogV2::model::CIAppCompute; use datadog_api_client::datadogV2::model::CIAppComputeType; use datadog_api_client::datadogV2::model::CIAppGroupByTotal; use datadog_api_client::datadogV2::model::CIAppPipelinesAggregateRequest; use datadog_api_client::datadogV2::model::CIAppPipelinesGroupBy; use datadog_api_client::datadogV2::model::CIAppPipelinesQueryFilter; use datadog_api_client::datadogV2::model::CIAppQueryOptions; #[tokio::main] async fn main() { let body = CIAppPipelinesAggregateRequest::new() .compute(vec![CIAppCompute::new( CIAppAggregationFunction::PERCENTILE_90, ) .metric("@duration".to_string()) .type_(CIAppComputeType::TOTAL)]) .filter( CIAppPipelinesQueryFilter::new() .from("now-15m".to_string()) .query("@ci.provider.name:(gitlab OR github)".to_string()) .to("now".to_string()), ) .group_by(vec![CIAppPipelinesGroupBy::new("@ci.status".to_string()) .limit(10) .total(CIAppGroupByTotal::CIAppGroupByTotalBoolean(false))]) .options(CIAppQueryOptions::new().timezone("GMT".to_string())); let configuration = datadog::Configuration::new(); let api = CIVisibilityPipelinesAPI::with_config(configuration); let resp = api.aggregate_ci_app_pipeline_events(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Aggregate pipelines events returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.CIVisibilityPipelinesApi(configuration); const params: v2.CIVisibilityPipelinesApiAggregateCIAppPipelineEventsRequest = { body: { compute: [ { aggregation: "pc90", metric: "@duration", type: "total", }, ], filter: { from: "now-15m", query: "@ci.provider.name:(gitlab OR github)", to: "now", }, groupBy: [ { facet: "@ci.status", limit: 10, total: false, }, ], options: { timezone: "GMT", }, }, }; apiInstance .aggregateCIAppPipelineEvents(params) .then((data: v2.CIAppPipelinesAnalyticsAggregateResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}