Skip to content

Add FormulaAndFunctionEventQueryGroupByFields schema to support flat group_by form #3542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nogates merged 3 commits into from
Mar 3, 2026
Merged

Add FormulaAndFunctionEventQueryGroupByFields schema to support flat group_by form #3542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
97093fc
Regenerate client from commit 4bfcbd9 of spec repo
Mar 2, 2026
18a68b1
Fix BDD test lookup to handle oneOf wrappers for array indexing
archana-asokan Mar 2, 2026
96ae275
Regenerate client from commit 6846005 of spec repo
Mar 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 35 additions & 4 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2962,10 +2962,7 @@ components:
data_source:
$ref: '#/components/schemas/FormulaAndFunctionEventsDataSource'
group_by:
description: Group by options.
items:
$ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupBy'
type: array
$ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupByConfig'
indexes:
description: An array of index names to query in the stream. Omit or use
`[]` to query all indexes at once.
Expand Down Expand Up @@ -3037,6 +3034,40 @@ components:
required:
- facet
type: object
FormulaAndFunctionEventQueryGroupByConfig:
description: Group by configuration for a formula and functions events query.
Accepts either a list of facet objects or a flat object that specifies a list
of facet fields.
oneOf:
- $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupByList'
- $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupByFields'
FormulaAndFunctionEventQueryGroupByFields:
description: Flat group by configuration using multiple event facet fields.
properties:
fields:
description: List of event facets to group by.
example:
- hostname
- service
items:
description: Event facet.
type: string
type: array
limit:
description: Number of groups to return.
example: 10
format: int64
type: integer
sort:
$ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupBySort'
required:
- fields
type: object
FormulaAndFunctionEventQueryGroupByList:
description: List of objects used to group by.
items:
$ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupBy'
type: array
FormulaAndFunctionEventQueryGroupBySort:
description: Options for sorting group by results.
properties:
Expand Down
26 changes: 14 additions & 12 deletions examples/v1/dashboards/CreateDashboard_1617893815.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionCompute;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionSearch;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryGroupBy;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryGroupByConfig;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryGroupBySort;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventsDataSource;
import com.datadog.api.client.v1.model.FormulaAndFunctionQueryDefinition;
Expand Down Expand Up @@ -71,18 +72,19 @@ public static void main(String[] args) {
.AVG)
.metric("@duration"))
.groupBy(
Collections.singletonList(
new FormulaAndFunctionEventQueryGroupBy()
.facet("service")
.limit(1000L)
.sort(
new FormulaAndFunctionEventQueryGroupBySort()
.aggregation(
FormulaAndFunctionEventAggregation
.COUNT)
.order(
QuerySortOrder
.DESC))))
new FormulaAndFunctionEventQueryGroupByConfig(
Collections.singletonList(
new FormulaAndFunctionEventQueryGroupBy()
.facet("service")
.limit(1000L)
.sort(
new FormulaAndFunctionEventQueryGroupBySort()
.aggregation(
FormulaAndFunctionEventAggregation
.COUNT)
.order(
QuerySortOrder
.DESC)))))
.storage("hot"))))))))))
.layoutType(DashboardLayoutType.FREE);

Expand Down
84 changes: 84 additions & 0 deletions examples/v1/dashboards/CreateDashboard_4018282928.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
// Create a new dashboard with formulas and functions events query using flat group by fields

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;
import com.datadog.api.client.v1.model.DashboardLayoutType;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventAggregation;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinition;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionCompute;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionSearch;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryGroupByConfig;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryGroupByFields;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventsDataSource;
import com.datadog.api.client.v1.model.FormulaAndFunctionQueryDefinition;
import com.datadog.api.client.v1.model.FormulaAndFunctionResponseFormat;
import com.datadog.api.client.v1.model.TimeseriesWidgetDefinition;
import com.datadog.api.client.v1.model.TimeseriesWidgetDefinitionType;
import com.datadog.api.client.v1.model.TimeseriesWidgetRequest;
import com.datadog.api.client.v1.model.Widget;
import com.datadog.api.client.v1.model.WidgetDefinition;
import com.datadog.api.client.v1.model.WidgetLayout;
import java.util.Arrays;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardsApi apiInstance = new DashboardsApi(defaultClient);

Dashboard body =
new Dashboard()
.title("Example-Dashboard with events flat group_by fields")
.widgets(
Collections.singletonList(
new Widget()
.definition(
new WidgetDefinition(
new TimeseriesWidgetDefinition()
.type(TimeseriesWidgetDefinitionType.TIMESERIES)
.requests(
Collections.singletonList(
new TimeseriesWidgetRequest()
.responseFormat(
FormulaAndFunctionResponseFormat.TIMESERIES)
.queries(
Collections.singletonList(
new FormulaAndFunctionQueryDefinition(
new FormulaAndFunctionEventQueryDefinition()
.dataSource(
FormulaAndFunctionEventsDataSource
.EVENTS)
.name("query1")
.search(
new FormulaAndFunctionEventQueryDefinitionSearch()
.query(""))
.compute(
new FormulaAndFunctionEventQueryDefinitionCompute()
.aggregation(
FormulaAndFunctionEventAggregation
.COUNT))
.groupBy(
new FormulaAndFunctionEventQueryGroupByConfig(
new FormulaAndFunctionEventQueryGroupByFields()
.fields(
Arrays.asList(
"service",
"host"))
.limit(10L))))))))))
.layout(new WidgetLayout().x(0L).y(0L).width(4L).height(2L))))
.layoutType(DashboardLayoutType.ORDERED);

try {
Dashboard result = apiInstance.createDashboard(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardsApi#createDashboard");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
82 changes: 82 additions & 0 deletions examples/v1/dashboards/CreateDashboard_732700533.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
// Create a new dashboard with formulas and functions events query using facet group by

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;
import com.datadog.api.client.v1.model.DashboardLayoutType;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventAggregation;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinition;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionCompute;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionSearch;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryGroupBy;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryGroupByConfig;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventsDataSource;
import com.datadog.api.client.v1.model.FormulaAndFunctionQueryDefinition;
import com.datadog.api.client.v1.model.FormulaAndFunctionResponseFormat;
import com.datadog.api.client.v1.model.TimeseriesWidgetDefinition;
import com.datadog.api.client.v1.model.TimeseriesWidgetDefinitionType;
import com.datadog.api.client.v1.model.TimeseriesWidgetRequest;
import com.datadog.api.client.v1.model.Widget;
import com.datadog.api.client.v1.model.WidgetDefinition;
import com.datadog.api.client.v1.model.WidgetLayout;
import java.util.Collections;

public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardsApi apiInstance = new DashboardsApi(defaultClient);

Dashboard body =
new Dashboard()
.title("Example-Dashboard with events facet group_by")
.widgets(
Collections.singletonList(
new Widget()
.definition(
new WidgetDefinition(
new TimeseriesWidgetDefinition()
.type(TimeseriesWidgetDefinitionType.TIMESERIES)
.requests(
Collections.singletonList(
new TimeseriesWidgetRequest()
.responseFormat(
FormulaAndFunctionResponseFormat.TIMESERIES)
.queries(
Collections.singletonList(
new FormulaAndFunctionQueryDefinition(
new FormulaAndFunctionEventQueryDefinition()
.dataSource(
FormulaAndFunctionEventsDataSource
.EVENTS)
.name("query1")
.search(
new FormulaAndFunctionEventQueryDefinitionSearch()
.query(""))
.compute(
new FormulaAndFunctionEventQueryDefinitionCompute()
.aggregation(
FormulaAndFunctionEventAggregation
.COUNT))
.groupBy(
new FormulaAndFunctionEventQueryGroupByConfig(
Collections.singletonList(
new FormulaAndFunctionEventQueryGroupBy()
.facet("service")
.limit(
10L)))))))))))
.layout(new WidgetLayout().x(0L).y(0L).width(4L).height(2L))))
.layoutType(DashboardLayoutType.ORDERED);

try {
Dashboard result = apiInstance.createDashboard(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardsApi#createDashboard");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
28 changes: 15 additions & 13 deletions examples/v1/dashboards/CreateDashboard_915214113.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionCompute;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionSearch;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryGroupBy;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryGroupByConfig;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryGroupBySort;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventsDataSource;
import com.datadog.api.client.v1.model.FormulaAndFunctionQueryDefinition;
Expand Down Expand Up @@ -80,19 +81,20 @@ public static void main(String[] args) {
FormulaAndFunctionEventAggregation
.COUNT))
.groupBy(
Collections.singletonList(
new FormulaAndFunctionEventQueryGroupBy()
.facet(
"@geo.country_iso_code")
.limit(250L)
.sort(
new FormulaAndFunctionEventQueryGroupBySort()
.order(
QuerySortOrder
.DESC)
.aggregation(
FormulaAndFunctionEventAggregation
.COUNT)))))))
new FormulaAndFunctionEventQueryGroupByConfig(
Collections.singletonList(
new FormulaAndFunctionEventQueryGroupBy()
.facet(
"@geo.country_iso_code")
.limit(250L)
.sort(
new FormulaAndFunctionEventQueryGroupBySort()
.order(
QuerySortOrder
.DESC)
.aggregation(
FormulaAndFunctionEventAggregation
.COUNT))))))))
.sort(
new WidgetSortBy()
.count(250L)
Expand Down
Loading
Loading