Add missing documentation

.generator/schemas/v1/openapi.yaml

@@ -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.
@@ -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:

.generator/schemas/v2/openapi.yaml

@@ -69929,6 +69929,7 @@ components:
       - data
       type: object
     ViewershipHistorySessionData:
+      description: Viewership history session data.
       properties:
         attributes:
           $ref: '#/components/schemas/ViewershipHistorySessionDataAttributes'

docs/datadog_api_client.v1.model.rst

@@ -928,6 +928,20 @@ datadog\_api\_client.v1.model.formula\_and\_function\_event\_query\_group\_by mo
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v1.model.formula\_and\_function\_event\_query\_group\_by\_config module
+--------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.formula_and_function_event_query_group_by_config
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.formula\_and\_function\_event\_query\_group\_by\_fields module
+--------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.formula_and_function_event_query_group_by_fields
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v1.model.formula\_and\_function\_event\_query\_group\_by\_sort module
 ------------------------------------------------------------------------------------------
 

examples/v1/dashboards/CreateDashboard_1024858348.py

@@ -55,7 +55,6 @@
                                 compute=FormulaAndFunctionEventQueryDefinitionCompute(
                                     aggregation=FormulaAndFunctionEventAggregation.COUNT,
                                 ),
-                                group_by=[],
                             ),
                         ],
                         response_format=FormulaAndFunctionResponseFormat.SCALAR,

examples/v1/dashboards/CreateDashboard_1307120899.py

@@ -69,7 +69,6 @@
                                 compute=FormulaAndFunctionEventQueryDefinitionCompute(
                                     aggregation=FormulaAndFunctionEventAggregation.COUNT,
                                 ),
-                                group_by=[],
                             ),
                         ],
                         response_format=FormulaAndFunctionResponseFormat.TIMESERIES,

examples/v1/dashboards/CreateDashboard_2064651578.py

@@ -64,7 +64,6 @@
                                 compute=FormulaAndFunctionEventQueryDefinitionCompute(
                                     aggregation=FormulaAndFunctionEventAggregation.COUNT,
                                 ),
-                                group_by=[],
                             ),
                         ],
                         response_format=FormulaAndFunctionResponseFormat.SCALAR,

examples/v1/dashboards/CreateDashboard_2490110261.py

@@ -47,7 +47,6 @@
                                 indexes=[
                                     "*",
                                 ],
-                                group_by=[],
                             ),
                         ],
                     ),

examples/v1/dashboards/CreateDashboard_2800096921.py

@@ -70,7 +70,6 @@
                                     aggregation=FormulaAndFunctionEventAggregation.COUNT,
                                     metric="@ci.queue_time",
                                 ),
-                                group_by=[],
                             ),
                         ],
                         response_format=FormulaAndFunctionResponseFormat.TIMESERIES,

examples/v1/dashboards/CreateDashboard_3066042014.py

@@ -77,7 +77,6 @@
                                     aggregation=FormulaAndFunctionEventAggregation.COUNT,
                                     metric="@ci.queue_time",
                                 ),
-                                group_by=[],
                             ),
                         ],
                         response_format=FormulaAndFunctionResponseFormat.TIMESERIES,

examples/v1/dashboards/CreateDashboard_3451918078.py

@@ -76,7 +76,6 @@
                                     aggregation=FormulaAndFunctionEventAggregation.COUNT,
                                     metric="@ci.queue_time",
                                 ),
-                                group_by=[],
                             ),
                         ],
                         response_format=FormulaAndFunctionResponseFormat.TIMESERIES,

examples/v1/dashboards/CreateDashboard_3669695268.py

@@ -51,7 +51,6 @@
                                 compute=FormulaAndFunctionEventQueryDefinitionCompute(
                                     aggregation=FormulaAndFunctionEventAggregation.COUNT,
                                 ),
-                                group_by=[],
                                 storage="online_archives",
                             ),
                         ],

examples/v1/dashboards/CreateDashboard_3882428227.py

@@ -65,7 +65,6 @@
                             indexes=[
                                 "*",
                             ],
-                            group_by=[],
                         ),
                         request_type=WidgetHistogramRequestType.HISTOGRAM,
                     ),

examples/v1/dashboards/CreateDashboard_4018282928.py

@@ -0,0 +1,77 @@
+"""
+Create a new dashboard with formulas and functions events query using flat group by fields
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.dashboards_api import DashboardsApi
+from datadog_api_client.v1.model.dashboard import Dashboard
+from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
+from datadog_api_client.v1.model.formula_and_function_event_aggregation import FormulaAndFunctionEventAggregation
+from datadog_api_client.v1.model.formula_and_function_event_query_definition import (
+    FormulaAndFunctionEventQueryDefinition,
+)
+from datadog_api_client.v1.model.formula_and_function_event_query_definition_compute import (
+    FormulaAndFunctionEventQueryDefinitionCompute,
+)
+from datadog_api_client.v1.model.formula_and_function_event_query_definition_search import (
+    FormulaAndFunctionEventQueryDefinitionSearch,
+)
+from datadog_api_client.v1.model.formula_and_function_event_query_group_by_fields import (
+    FormulaAndFunctionEventQueryGroupByFields,
+)
+from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource
+from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
+from datadog_api_client.v1.model.timeseries_widget_definition import TimeseriesWidgetDefinition
+from datadog_api_client.v1.model.timeseries_widget_definition_type import TimeseriesWidgetDefinitionType
+from datadog_api_client.v1.model.timeseries_widget_request import TimeseriesWidgetRequest
+from datadog_api_client.v1.model.widget import Widget
+from datadog_api_client.v1.model.widget_layout import WidgetLayout
+
+body = Dashboard(
+    title="Example-Dashboard with events flat group_by fields",
+    widgets=[
+        Widget(
+            definition=TimeseriesWidgetDefinition(
+                type=TimeseriesWidgetDefinitionType.TIMESERIES,
+                requests=[
+                    TimeseriesWidgetRequest(
+                        response_format=FormulaAndFunctionResponseFormat.TIMESERIES,
+                        queries=[
+                            FormulaAndFunctionEventQueryDefinition(
+                                data_source=FormulaAndFunctionEventsDataSource.EVENTS,
+                                name="query1",
+                                search=FormulaAndFunctionEventQueryDefinitionSearch(
+                                    query="",
+                                ),
+                                compute=FormulaAndFunctionEventQueryDefinitionCompute(
+                                    aggregation=FormulaAndFunctionEventAggregation.COUNT,
+                                ),
+                                group_by=FormulaAndFunctionEventQueryGroupByFields(
+                                    fields=[
+                                        "service",
+                                        "host",
+                                    ],
+                                    limit=10,
+                                ),
+                            ),
+                        ],
+                    ),
+                ],
+            ),
+            layout=WidgetLayout(
+                x=0,
+                y=0,
+                width=4,
+                height=2,
+            ),
+        ),
+    ],
+    layout_type=DashboardLayoutType.ORDERED,
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = DashboardsApi(api_client)
+    response = api_instance.create_dashboard(body=body)
+
+    print(response)

examples/v1/dashboards/CreateDashboard_4262729673.py

@@ -74,7 +74,6 @@
                                     aggregation=FormulaAndFunctionEventAggregation.COUNT,
                                     metric="@ci.queue_time",
                                 ),
-                                group_by=[],
                             ),
                         ],
                         response_format=FormulaAndFunctionResponseFormat.TIMESERIES,

examples/v1/dashboards/CreateDashboard_578885732.py

@@ -64,7 +64,6 @@
                                 compute=FormulaAndFunctionEventQueryDefinitionCompute(
                                     aggregation=FormulaAndFunctionEventAggregation.COUNT,
                                 ),
-                                group_by=[],
                             ),
                         ],
                         response_format=FormulaAndFunctionResponseFormat.SCALAR,

examples/v1/dashboards/CreateDashboard_607525069.py

@@ -69,7 +69,6 @@
                                 compute=FormulaAndFunctionEventQueryDefinitionCompute(
                                     aggregation=FormulaAndFunctionEventAggregation.COUNT,
                                 ),
-                                group_by=[],
                             ),
                         ],
                         response_format=FormulaAndFunctionResponseFormat.TIMESERIES,

examples/v1/dashboards/CreateDashboard_732700533.py

@@ -0,0 +1,74 @@
+"""
+Create a new dashboard with formulas and functions events query using facet group by
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.dashboards_api import DashboardsApi
+from datadog_api_client.v1.model.dashboard import Dashboard
+from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
+from datadog_api_client.v1.model.formula_and_function_event_aggregation import FormulaAndFunctionEventAggregation
+from datadog_api_client.v1.model.formula_and_function_event_query_definition import (
+    FormulaAndFunctionEventQueryDefinition,
+)
+from datadog_api_client.v1.model.formula_and_function_event_query_definition_compute import (
+    FormulaAndFunctionEventQueryDefinitionCompute,
+)
+from datadog_api_client.v1.model.formula_and_function_event_query_definition_search import (
+    FormulaAndFunctionEventQueryDefinitionSearch,
+)
+from datadog_api_client.v1.model.formula_and_function_event_query_group_by import FormulaAndFunctionEventQueryGroupBy
+from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource
+from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
+from datadog_api_client.v1.model.timeseries_widget_definition import TimeseriesWidgetDefinition
+from datadog_api_client.v1.model.timeseries_widget_definition_type import TimeseriesWidgetDefinitionType
+from datadog_api_client.v1.model.timeseries_widget_request import TimeseriesWidgetRequest
+from datadog_api_client.v1.model.widget import Widget
+from datadog_api_client.v1.model.widget_layout import WidgetLayout
+
+body = Dashboard(
+    title="Example-Dashboard with events facet group_by",
+    widgets=[
+        Widget(
+            definition=TimeseriesWidgetDefinition(
+                type=TimeseriesWidgetDefinitionType.TIMESERIES,
+                requests=[
+                    TimeseriesWidgetRequest(
+                        response_format=FormulaAndFunctionResponseFormat.TIMESERIES,
+                        queries=[
+                            FormulaAndFunctionEventQueryDefinition(
+                                data_source=FormulaAndFunctionEventsDataSource.EVENTS,
+                                name="query1",
+                                search=FormulaAndFunctionEventQueryDefinitionSearch(
+                                    query="",
+                                ),
+                                compute=FormulaAndFunctionEventQueryDefinitionCompute(
+                                    aggregation=FormulaAndFunctionEventAggregation.COUNT,
+                                ),
+                                group_by=[
+                                    FormulaAndFunctionEventQueryGroupBy(
+                                        facet="service",
+                                        limit=10,
+                                    ),
+                                ],
+                            ),
+                        ],
+                    ),
+                ],
+            ),
+            layout=WidgetLayout(
+                x=0,
+                y=0,
+                width=4,
+                height=2,
+            ),
+        ),
+    ],
+    layout_type=DashboardLayoutType.ORDERED,
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = DashboardsApi(api_client)
+    response = api_instance.create_dashboard(body=body)
+
+    print(response)

examples/v1/dashboards/CreateDashboard_9836563.py

@@ -68,7 +68,6 @@
                                 compute=FormulaAndFunctionEventQueryDefinitionCompute(
                                     aggregation=FormulaAndFunctionEventAggregation.COUNT,
                                 ),
-                                group_by=[],
                             ),
                         ],
                         conditional_formats=[

examples/v1/dashboards/CreateDashboard_985012506.py

@@ -69,7 +69,6 @@
                                 compute=FormulaAndFunctionEventQueryDefinitionCompute(
                                     aggregation=FormulaAndFunctionEventAggregation.COUNT,
                                 ),
-                                group_by=[],
                             ),
                         ],
                         response_format=FormulaAndFunctionResponseFormat.TIMESERIES,

src/datadog_api_client/v1/model/distribution_widget_histogram_request_query.py

@@ -36,8 +36,8 @@ def __init__(self, **kwargs):
         :param compute: Compute options.
         :type compute: FormulaAndFunctionEventQueryDefinitionCompute
 
-        :param group_by: Group by options.
-        :type group_by: [FormulaAndFunctionEventQueryGroupBy], optional
+        :param group_by: 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.
+        :type group_by: FormulaAndFunctionEventQueryGroupByConfig, optional
 
         :param indexes: An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
         :type indexes: [str], optional