Aggregate pipelines events
https://api.datadoghq.com/api/v2/ci/pipelines/analytics/aggregatehttps://api.us3.datadoghq.com/api/v2/ci/pipelines/analytics/aggregatehttps://api.us5.datadoghq.com/api/v2/ci/pipelines/analytics/aggregatehttps://api.datadoghq.eu/api/v2/ci/pipelines/analytics/aggregatehttps://api.ap1.datadoghq.com/api/v2/ci/pipelines/analytics/aggregatehttps://api.ap2.datadoghq.com/api/v2/ci/pipelines/analytics/aggregatehttps://api.uk1.datadoghq.com/api/v2/ci/pipelines/analytics/aggregatehttps://api.ddog-gov.com/api/v2/ci/pipelines/analytics/aggregatehttps://api.us2.ddog-gov.com/api/v2/ci/pipelines/analytics/aggregateOverview
Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries.
OAuth apps require the ci_visibility_read authorization scope to access this endpoint.
Request
Body Data (required)
computeThe list of metrics or timeseries to compute for the retrieved buckets.
aggregation [required]An aggregation function.
count, cardinality, pc75, pc90, pc95, pc98, pc99, sum, min, maxShow 6 more
avg, median, latest, earliest, most_frequent, deltaintervalThe time buckets' size (only used for type=timeseries) Defaults to a resolution of 150 points.
metricThe metric to use.
typeThe type of compute.
totaltimeseries, totalfilterThe search and filter query settings.
fromThe minimum time for the requested events; supports date, math, and regular timestamps (in milliseconds).
now-15mqueryThe search query following the CI Visibility Explorer search syntax.
*toThe maximum time for the requested events, supports date, math, and regular timestamps (in milliseconds).
nowgroup_byThe rules for the group-by.
facet [required]The name of the facet to use (required).
histogramUsed to perform a histogram computation (only for measure facets).
At most, 100 buckets are allowed, the number of buckets is (max - min)/interval.
interval [required]The bin size of the histogram buckets.
max [required]The maximum value for the measure used in the histogram (values greater than this one are filtered out).
min [required]The minimum value for the measure used in the histogram (values smaller than this one are filtered out).
limitThe maximum buckets to return for this group-by.
10missingThe value to use for logs that don't have the facet used to group-by.
Object 1The missing value to use if there is a string valued facet.
Object 2The missing value to use if there is a number valued facet.
sortA sort rule. The aggregation field is required when type is measure.
aggregationAn aggregation function.
count, cardinality, pc75, pc90, pc95, pc98, pc99, sum, min, maxShow 6 more
avg, median, latest, earliest, most_frequent, deltametricThe metric to sort by (only used for type=measure).
orderThe order to use, ascending or descending.
asc, desctypeThe type of sorting algorithm.
alphabeticalalphabetical, measuretotalA resulting object to put the given computes in over all the matching records.
Object 1If set to true, creates an additional bucket labeled "$facet_total".
Object 2A string to use as the key value for the total bucket.
Object 3A number to use as the key value for the total bucket.
optionsGlobal query options that are used during the query. Only supply timezone or time offset, not both. Otherwise, the query fails.
time_offsetThe time offset (in seconds) to apply to the query.
timezoneThe timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).
UTC{
"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"
}
}Response
OK
The response object for the pipeline events aggregate API endpoint.
dataThe query results.
bucketsThe list of matching buckets, one item per bucket.
byThe key-value pairs for each group-by.
<any-key>The values for each group-by.
computesA map of the metric name to value for regular compute, or a list of values for a timeseries.
<any-key>A bucket value, can either be a timeseries or a single value.
Object 1A single string value.
Object 2A single number value.
Object 3A timeseries array.
timeThe time value for this point.
valueThe value for this point.
linksLinks attributes.
nextLink for the next set of results. The request can also be made using the POST endpoint.
metaThe metadata associated with a request.
elapsedThe time elapsed in milliseconds.
request_idThe identifier of the request.
statusThe status of the response.
done, timeoutwarningsA list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response.
codeA unique code for this type of warning.
detailA detailed explanation of this specific warning.
titleA short human-readable summary of the warning.
{
"data": {
"buckets": [
{
"by": {
"<any-key>": "undefined"
},
"computes": {
"<any-key>": {
"description": "undefined",
"type": "undefined"
}
}
}
]
},
"links": {
"next": "https://app.datadoghq.com/api/v2/ci/tests/events?filter[query]=foo&page[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"
}
]
}
}Bad Request
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Not Authorized
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
errors [required]A list of errors.
{
"errors": [
"Bad Request"
]
}Code Example
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/ci/pipelines/analytics/aggregate" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"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"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/ci/pipelines/analytics/aggregate" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"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"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/ci/pipelines/analytics/aggregate" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"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"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/ci/pipelines/analytics/aggregate" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"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"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/ci/pipelines/analytics/aggregate" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"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"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/ci/pipelines/analytics/aggregate" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"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"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/ci/pipelines/analytics/aggregate" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"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"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/ci/pipelines/analytics/aggregate" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"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"
}
}
EOF# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/ci/pipelines/analytics/aggregate" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"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"
}
}
EOF// 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())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
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 and then save the example to main.go and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"// 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();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
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 and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java""""
Aggregate pipelines events returns "OK" response
"""
from os import environ
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()
configuration.access_token = environ["DD_BEARER_TOKEN"]
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 and then save the example to example.py and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"# Aggregate pipelines events returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
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 and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"// 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 and then save the example to src/main.rs and run following commands:
DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run/**
* Aggregate pipelines events returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
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 and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"