Document supported dashboard widget timeframes

.generator/schemas/v1/openapi.yaml

@@ -27920,6 +27920,42 @@ components:
     WidgetBackgroundColor:
       description: "Background color of the widget. Supported values are `white`, `blue`, `purple`, `pink`, `orange`, `yellow`, `green`, `gray`, `vivid_blue`, `vivid_purple`, `vivid_pink`, `vivid_orange`, `vivid_yellow`, `vivid_green`, and `transparent`."
       type: string
+    WidgetCalendarAlignedSpan:
+      description: Used for calendar-aligned time spans, such as the current month or previous year.
+      properties:
+        hide_incomplete_cost_data:
+          description: Whether to hide incomplete cost data in the widget.
+          type: boolean
+        offset:
+          description: Number of completed periods before the current period. 0 represents the current period.
+          example: 1
+          format: int64
+          minimum: 0
+          type: integer
+        timezone:
+          description: Time zone used to align the calendar period.
+          example: UTC
+          type: string
+        type:
+          $ref: "#/components/schemas/WidgetCalendarAlignedSpanType"
+      required:
+        - type
+        - offset
+      type: object
+    WidgetCalendarAlignedSpanType:
+      description: Calendar-aligned time span type.
+      enum:
+        - daily
+        - weekly
+        - monthly
+        - yearly
+      example: daily
+      type: string
+      x-enum-varnames:
+        - DAILY
+        - WEEKLY
+        - MONTHLY
+        - YEARLY
     WidgetChangeType:
       description: Show the absolute or the relative change.
       enum:
@@ -28381,6 +28417,9 @@ components:
         - month_to_date
         - 1y
         - alert
+        - full_week
+        - full_month
+        - year_to_date
       example: 5m
       type: string
       x-enum-varnames:
@@ -28401,6 +28440,9 @@ components:
         - MONTH_TO_DATE
         - PAST_ONE_YEAR
         - ALERT
+        - FULL_WEEK
+        - FULL_MONTH
+        - YEAR_TO_DATE
     WidgetLiveSpanUnit:
       description: Unit of the time span.
       enum:
@@ -28784,6 +28826,7 @@ components:
         - $ref: "#/components/schemas/WidgetLegacyLiveSpan"
         - $ref: "#/components/schemas/WidgetNewLiveSpan"
         - $ref: "#/components/schemas/WidgetNewFixedSpan"
+        - $ref: "#/components/schemas/WidgetCalendarAlignedSpan"
     WidgetTimeWindows:
       description: Define a time window.
       enum:

docs/datadog_api_client.v1.model.rst

@@ -7725,6 +7725,20 @@ datadog\_api\_client.v1.model.widget\_axis module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v1.model.widget\_calendar\_aligned\_span module
+--------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.widget_calendar_aligned_span
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.widget\_calendar\_aligned\_span\_type module
+--------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.widget_calendar_aligned_span_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v1.model.widget\_change\_type module
 ---------------------------------------------------------
 

src/datadog_api_client/v1/model/alert_graph_widget_definition.py

@@ -21,6 +21,7 @@
     from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan
     from datadog_api_client.v1.model.widget_new_live_span import WidgetNewLiveSpan
     from datadog_api_client.v1.model.widget_new_fixed_span import WidgetNewFixedSpan
+    from datadog_api_client.v1.model.widget_calendar_aligned_span import WidgetCalendarAlignedSpan
 
 
 class AlertGraphWidgetDefinition(ModelNormal):
@@ -59,7 +60,14 @@ def __init__(
         type: AlertGraphWidgetDefinitionType,
         viz_type: WidgetVizType,
         description: Union[str, UnsetType] = unset,
-        time: Union[WidgetTime, WidgetLegacyLiveSpan, WidgetNewLiveSpan, WidgetNewFixedSpan, UnsetType] = unset,
+        time: Union[
+            WidgetTime,
+            WidgetLegacyLiveSpan,
+            WidgetNewLiveSpan,
+            WidgetNewFixedSpan,
+            WidgetCalendarAlignedSpan,
+            UnsetType,
+        ] = unset,
         title: Union[str, UnsetType] = unset,
         title_align: Union[WidgetTextAlign, UnsetType] = unset,
         title_size: Union[str, UnsetType] = unset,

src/datadog_api_client/v1/model/bar_chart_widget_definition.py

@@ -23,6 +23,7 @@
     from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan
     from datadog_api_client.v1.model.widget_new_live_span import WidgetNewLiveSpan
     from datadog_api_client.v1.model.widget_new_fixed_span import WidgetNewFixedSpan
+    from datadog_api_client.v1.model.widget_calendar_aligned_span import WidgetCalendarAlignedSpan
 
 
 class BarChartWidgetDefinition(ModelNormal):
@@ -73,7 +74,14 @@ def __init__(
         custom_links: Union[List[WidgetCustomLink], UnsetType] = unset,
         description: Union[str, UnsetType] = unset,
         style: Union[BarChartWidgetStyle, UnsetType] = unset,
-        time: Union[WidgetTime, WidgetLegacyLiveSpan, WidgetNewLiveSpan, WidgetNewFixedSpan, UnsetType] = unset,
+        time: Union[
+            WidgetTime,
+            WidgetLegacyLiveSpan,
+            WidgetNewLiveSpan,
+            WidgetNewFixedSpan,
+            WidgetCalendarAlignedSpan,
+            UnsetType,
+        ] = unset,
         title: Union[str, UnsetType] = unset,
         title_align: Union[WidgetTextAlign, UnsetType] = unset,
         title_size: Union[str, UnsetType] = unset,

src/datadog_api_client/v1/model/change_widget_definition.py

@@ -22,6 +22,7 @@
     from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan
     from datadog_api_client.v1.model.widget_new_live_span import WidgetNewLiveSpan
     from datadog_api_client.v1.model.widget_new_fixed_span import WidgetNewFixedSpan
+    from datadog_api_client.v1.model.widget_calendar_aligned_span import WidgetCalendarAlignedSpan
 
 
 class ChangeWidgetDefinition(ModelNormal):
@@ -68,7 +69,14 @@ def __init__(
         type: ChangeWidgetDefinitionType,
         custom_links: Union[List[WidgetCustomLink], UnsetType] = unset,
         description: Union[str, UnsetType] = unset,
-        time: Union[WidgetTime, WidgetLegacyLiveSpan, WidgetNewLiveSpan, WidgetNewFixedSpan, UnsetType] = unset,
+        time: Union[
+            WidgetTime,
+            WidgetLegacyLiveSpan,
+            WidgetNewLiveSpan,
+            WidgetNewFixedSpan,
+            WidgetCalendarAlignedSpan,
+            UnsetType,
+        ] = unset,
         title: Union[str, UnsetType] = unset,
         title_align: Union[WidgetTextAlign, UnsetType] = unset,
         title_size: Union[str, UnsetType] = unset,

src/datadog_api_client/v1/model/check_status_widget_definition.py

@@ -21,6 +21,7 @@
     from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan
     from datadog_api_client.v1.model.widget_new_live_span import WidgetNewLiveSpan
     from datadog_api_client.v1.model.widget_new_fixed_span import WidgetNewFixedSpan
+    from datadog_api_client.v1.model.widget_calendar_aligned_span import WidgetCalendarAlignedSpan
 
 
 class CheckStatusWidgetDefinition(ModelNormal):
@@ -68,7 +69,14 @@ def __init__(
         group: Union[str, UnsetType] = unset,
         group_by: Union[List[str], UnsetType] = unset,
         tags: Union[List[str], UnsetType] = unset,
-        time: Union[WidgetTime, WidgetLegacyLiveSpan, WidgetNewLiveSpan, WidgetNewFixedSpan, UnsetType] = unset,
+        time: Union[
+            WidgetTime,
+            WidgetLegacyLiveSpan,
+            WidgetNewLiveSpan,
+            WidgetNewFixedSpan,
+            WidgetCalendarAlignedSpan,
+            UnsetType,
+        ] = unset,
         title: Union[str, UnsetType] = unset,
         title_align: Union[WidgetTextAlign, UnsetType] = unset,
         title_size: Union[str, UnsetType] = unset,

src/datadog_api_client/v1/model/cohort_widget_definition.py

@@ -21,6 +21,7 @@
     from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan
     from datadog_api_client.v1.model.widget_new_live_span import WidgetNewLiveSpan
     from datadog_api_client.v1.model.widget_new_fixed_span import WidgetNewFixedSpan
+    from datadog_api_client.v1.model.widget_calendar_aligned_span import WidgetCalendarAlignedSpan
 
 
 class CohortWidgetDefinition(ModelNormal):
@@ -66,7 +67,14 @@ def __init__(
         requests: List[RetentionGridRequest],
         type: CohortWidgetDefinitionType,
         description: Union[str, UnsetType] = unset,
-        time: Union[WidgetTime, WidgetLegacyLiveSpan, WidgetNewLiveSpan, WidgetNewFixedSpan, UnsetType] = unset,
+        time: Union[
+            WidgetTime,
+            WidgetLegacyLiveSpan,
+            WidgetNewLiveSpan,
+            WidgetNewFixedSpan,
+            WidgetCalendarAlignedSpan,
+            UnsetType,
+        ] = unset,
         title: Union[str, UnsetType] = unset,
         title_align: Union[WidgetTextAlign, UnsetType] = unset,
         title_size: Union[str, UnsetType] = unset,

src/datadog_api_client/v1/model/distribution_widget_definition.py

@@ -25,6 +25,7 @@
     from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan
     from datadog_api_client.v1.model.widget_new_live_span import WidgetNewLiveSpan
     from datadog_api_client.v1.model.widget_new_fixed_span import WidgetNewFixedSpan
+    from datadog_api_client.v1.model.widget_calendar_aligned_span import WidgetCalendarAlignedSpan
 
 
 class DistributionWidgetDefinition(ModelNormal):
@@ -87,7 +88,14 @@ def __init__(
         legend_size: Union[str, UnsetType] = unset,
         markers: Union[List[WidgetMarker], UnsetType] = unset,
         show_legend: Union[bool, UnsetType] = unset,
-        time: Union[WidgetTime, WidgetLegacyLiveSpan, WidgetNewLiveSpan, WidgetNewFixedSpan, UnsetType] = unset,
+        time: Union[
+            WidgetTime,
+            WidgetLegacyLiveSpan,
+            WidgetNewLiveSpan,
+            WidgetNewFixedSpan,
+            WidgetCalendarAlignedSpan,
+            UnsetType,
+        ] = unset,
         title: Union[str, UnsetType] = unset,
         title_align: Union[WidgetTextAlign, UnsetType] = unset,
         title_size: Union[str, UnsetType] = unset,

src/datadog_api_client/v1/model/event_stream_widget_definition.py

@@ -21,6 +21,7 @@
     from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan
     from datadog_api_client.v1.model.widget_new_live_span import WidgetNewLiveSpan
     from datadog_api_client.v1.model.widget_new_fixed_span import WidgetNewFixedSpan
+    from datadog_api_client.v1.model.widget_calendar_aligned_span import WidgetCalendarAlignedSpan
 
 
 class EventStreamWidgetDefinition(ModelNormal):
@@ -62,7 +63,14 @@ def __init__(
         description: Union[str, UnsetType] = unset,
         event_size: Union[WidgetEventSize, UnsetType] = unset,
         tags_execution: Union[str, UnsetType] = unset,
-        time: Union[WidgetTime, WidgetLegacyLiveSpan, WidgetNewLiveSpan, WidgetNewFixedSpan, UnsetType] = unset,
+        time: Union[
+            WidgetTime,
+            WidgetLegacyLiveSpan,
+            WidgetNewLiveSpan,
+            WidgetNewFixedSpan,
+            WidgetCalendarAlignedSpan,
+            UnsetType,
+        ] = unset,
         title: Union[str, UnsetType] = unset,
         title_align: Union[WidgetTextAlign, UnsetType] = unset,
         title_size: Union[str, UnsetType] = unset,

src/datadog_api_client/v1/model/event_timeline_widget_definition.py

@@ -20,6 +20,7 @@
     from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan
     from datadog_api_client.v1.model.widget_new_live_span import WidgetNewLiveSpan
     from datadog_api_client.v1.model.widget_new_fixed_span import WidgetNewFixedSpan
+    from datadog_api_client.v1.model.widget_calendar_aligned_span import WidgetCalendarAlignedSpan
 
 
 class EventTimelineWidgetDefinition(ModelNormal):
@@ -57,7 +58,14 @@ def __init__(
         type: EventTimelineWidgetDefinitionType,
         description: Union[str, UnsetType] = unset,
         tags_execution: Union[str, UnsetType] = unset,
-        time: Union[WidgetTime, WidgetLegacyLiveSpan, WidgetNewLiveSpan, WidgetNewFixedSpan, UnsetType] = unset,
+        time: Union[
+            WidgetTime,
+            WidgetLegacyLiveSpan,
+            WidgetNewLiveSpan,
+            WidgetNewFixedSpan,
+            WidgetCalendarAlignedSpan,
+            UnsetType,
+        ] = unset,
         title: Union[str, UnsetType] = unset,
         title_align: Union[WidgetTextAlign, UnsetType] = unset,
         title_size: Union[str, UnsetType] = unset,

src/datadog_api_client/v1/model/funnel_widget_definition.py

@@ -22,6 +22,7 @@
     from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan
     from datadog_api_client.v1.model.widget_new_live_span import WidgetNewLiveSpan
     from datadog_api_client.v1.model.widget_new_fixed_span import WidgetNewFixedSpan
+    from datadog_api_client.v1.model.widget_calendar_aligned_span import WidgetCalendarAlignedSpan
 
 
 class FunnelWidgetDefinition(ModelNormal):
@@ -67,7 +68,14 @@ def __init__(
         type: FunnelWidgetDefinitionType,
         description: Union[str, UnsetType] = unset,
         grouped_display: Union[FunnelGroupedDisplay, UnsetType] = unset,
-        time: Union[WidgetTime, WidgetLegacyLiveSpan, WidgetNewLiveSpan, WidgetNewFixedSpan, UnsetType] = unset,
+        time: Union[
+            WidgetTime,
+            WidgetLegacyLiveSpan,
+            WidgetNewLiveSpan,
+            WidgetNewFixedSpan,
+            WidgetCalendarAlignedSpan,
+            UnsetType,
+        ] = unset,
         title: Union[str, UnsetType] = unset,
         title_align: Union[WidgetTextAlign, UnsetType] = unset,
         title_size: Union[str, UnsetType] = unset,

src/datadog_api_client/v1/model/geomap_widget_definition.py

@@ -24,6 +24,7 @@
     from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan
     from datadog_api_client.v1.model.widget_new_live_span import WidgetNewLiveSpan
     from datadog_api_client.v1.model.widget_new_fixed_span import WidgetNewFixedSpan
+    from datadog_api_client.v1.model.widget_calendar_aligned_span import WidgetCalendarAlignedSpan
 
 
 class GeomapWidgetDefinition(ModelNormal):
@@ -78,7 +79,14 @@ def __init__(
         view: GeomapWidgetDefinitionView,
         custom_links: Union[List[WidgetCustomLink], UnsetType] = unset,
         description: Union[str, UnsetType] = unset,
-        time: Union[WidgetTime, WidgetLegacyLiveSpan, WidgetNewLiveSpan, WidgetNewFixedSpan, UnsetType] = unset,
+        time: Union[
+            WidgetTime,
+            WidgetLegacyLiveSpan,
+            WidgetNewLiveSpan,
+            WidgetNewFixedSpan,
+            WidgetCalendarAlignedSpan,
+            UnsetType,
+        ] = unset,
         title: Union[str, UnsetType] = unset,
         title_align: Union[WidgetTextAlign, UnsetType] = unset,
         title_size: Union[str, UnsetType] = unset,

src/datadog_api_client/v1/model/heat_map_widget_definition.py

@@ -26,6 +26,7 @@
     from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan
     from datadog_api_client.v1.model.widget_new_live_span import WidgetNewLiveSpan
     from datadog_api_client.v1.model.widget_new_fixed_span import WidgetNewFixedSpan
+    from datadog_api_client.v1.model.widget_calendar_aligned_span import WidgetCalendarAlignedSpan
 
 
 class HeatMapWidgetDefinition(ModelNormal):
@@ -92,7 +93,14 @@ def __init__(
         legend_size: Union[str, UnsetType] = unset,
         markers: Union[List[WidgetMarker], UnsetType] = unset,
         show_legend: Union[bool, UnsetType] = unset,
-        time: Union[WidgetTime, WidgetLegacyLiveSpan, WidgetNewLiveSpan, WidgetNewFixedSpan, UnsetType] = unset,
+        time: Union[
+            WidgetTime,
+            WidgetLegacyLiveSpan,
+            WidgetNewLiveSpan,
+            WidgetNewFixedSpan,
+            WidgetCalendarAlignedSpan,
+            UnsetType,
+        ] = unset,
         title: Union[str, UnsetType] = unset,
         title_align: Union[WidgetTextAlign, UnsetType] = unset,
         title_size: Union[str, UnsetType] = unset,

src/datadog_api_client/v1/model/list_stream_widget_definition.py

@@ -21,6 +21,7 @@
     from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan
     from datadog_api_client.v1.model.widget_new_live_span import WidgetNewLiveSpan
     from datadog_api_client.v1.model.widget_new_fixed_span import WidgetNewFixedSpan
+    from datadog_api_client.v1.model.widget_calendar_aligned_span import WidgetCalendarAlignedSpan
 
 
 class ListStreamWidgetDefinition(ModelNormal):
@@ -69,7 +70,14 @@ def __init__(
         description: Union[str, UnsetType] = unset,
         legend_size: Union[str, UnsetType] = unset,
         show_legend: Union[bool, UnsetType] = unset,
-        time: Union[WidgetTime, WidgetLegacyLiveSpan, WidgetNewLiveSpan, WidgetNewFixedSpan, UnsetType] = unset,
+        time: Union[
+            WidgetTime,
+            WidgetLegacyLiveSpan,
+            WidgetNewLiveSpan,
+            WidgetNewFixedSpan,
+            WidgetCalendarAlignedSpan,
+            UnsetType,
+        ] = unset,
         title: Union[str, UnsetType] = unset,
         title_align: Union[WidgetTextAlign, UnsetType] = unset,
         title_size: Union[str, UnsetType] = unset,