Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
170 changes: 170 additions & 0 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -895,6 +895,174 @@ components:
items:
$ref: '#/components/schemas/AzureAccount'
type: array
BarChartWidgetDefinition:
description: The bar chart visualization displays categorical data using vertical
bars, allowing you to compare values across different groups.
properties:
custom_links:
description: List of custom links.
items:
$ref: '#/components/schemas/WidgetCustomLink'
type: array
requests:
description: List of bar chart widget requests.
example:
- q: system.load.1
items:
$ref: '#/components/schemas/BarChartWidgetRequest'
maxItems: 1
minItems: 1
type: array
style:
$ref: '#/components/schemas/BarChartWidgetStyle'
time:
$ref: '#/components/schemas/WidgetTime'
title:
description: Title of your widget.
type: string
title_align:
$ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
$ref: '#/components/schemas/BarChartWidgetDefinitionType'
required:
- type
- requests
type: object
BarChartWidgetDefinitionType:
default: bar_chart
description: Type of the bar chart widget.
enum:
- bar_chart
example: bar_chart
type: string
x-enum-varnames:
- BAR_CHART
BarChartWidgetDisplay:
description: Bar chart widget display options.
oneOf:
- $ref: '#/components/schemas/BarChartWidgetStacked'
- $ref: '#/components/schemas/BarChartWidgetFlat'
BarChartWidgetFlat:
description: Bar chart widget flat display.
properties:
type:
$ref: '#/components/schemas/BarChartWidgetFlatType'
required:
- type
type: object
BarChartWidgetFlatType:
default: flat
description: Bar chart widget flat display type.
enum:
- flat
example: flat
type: string
x-enum-varnames:
- FLAT
BarChartWidgetLegend:
description: Bar chart widget stacked legend behavior.
enum:
- automatic
- inline
- none
example: automatic
type: string
x-enum-varnames:
- AUTOMATIC
- INLINE
- NONE
BarChartWidgetRequest:
description: Updated bar chart widget.
properties:
apm_query:
$ref: '#/components/schemas/LogQueryDefinition'
audit_query:
$ref: '#/components/schemas/LogQueryDefinition'
conditional_formats:
description: List of conditional formats.
example:
- comparator: '>='
palette: blue
value: 1.0
items:
$ref: '#/components/schemas/WidgetConditionalFormat'
type: array
event_query:
$ref: '#/components/schemas/LogQueryDefinition'
formulas:
description: List of formulas that operate on queries.
items:
$ref: '#/components/schemas/WidgetFormula'
type: array
log_query:
$ref: '#/components/schemas/LogQueryDefinition'
network_query:
$ref: '#/components/schemas/LogQueryDefinition'
process_query:
$ref: '#/components/schemas/ProcessQueryDefinition'
profile_metrics_query:
$ref: '#/components/schemas/LogQueryDefinition'
q:
description: Widget query.
type: string
queries:
description: List of queries that can be returned directly or used in formulas.
items:
$ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
response_format:
$ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
rum_query:
$ref: '#/components/schemas/LogQueryDefinition'
security_query:
$ref: '#/components/schemas/LogQueryDefinition'
sort:
$ref: '#/components/schemas/WidgetSortBy'
style:
$ref: '#/components/schemas/WidgetRequestStyle'
type: object
BarChartWidgetScaling:
description: Bar chart widget scaling definition.
enum:
- absolute
- relative
type: string
x-enum-varnames:
- ABSOLUTE
- RELATIVE
BarChartWidgetStacked:
description: Bar chart widget stacked display options.
properties:
legend:
$ref: '#/components/schemas/BarChartWidgetLegend'
type:
$ref: '#/components/schemas/BarChartWidgetStackedType'
required:
- type
type: object
BarChartWidgetStackedType:
default: stacked
description: Bar chart widget stacked display type.
enum:
- stacked
example: stacked
type: string
x-enum-varnames:
- STACKED
BarChartWidgetStyle:
description: Style customization for a bar chart widget.
properties:
display:
$ref: '#/components/schemas/BarChartWidgetDisplay'
palette:
description: Color palette to apply to the widget.
type: string
scaling:
$ref: '#/components/schemas/BarChartWidgetScaling'
type: object
CancelDowntimesByScopeRequest:
description: Cancel downtimes according to scope.
properties:
Expand Down Expand Up @@ -14338,6 +14506,7 @@ components:
SplitGraphSourceWidgetDefinition:
description: The original widget we are splitting on.
oneOf:
- $ref: '#/components/schemas/BarChartWidgetDefinition'
- $ref: '#/components/schemas/ChangeWidgetDefinition'
- $ref: '#/components/schemas/GeomapWidgetDefinition'
- $ref: '#/components/schemas/QueryValueWidgetDefinition'
Expand Down Expand Up @@ -24829,6 +24998,7 @@ components:
oneOf:
- $ref: '#/components/schemas/AlertGraphWidgetDefinition'
- $ref: '#/components/schemas/AlertValueWidgetDefinition'
- $ref: '#/components/schemas/BarChartWidgetDefinition'
- $ref: '#/components/schemas/ChangeWidgetDefinition'
- $ref: '#/components/schemas/CheckStatusWidgetDefinition'
- $ref: '#/components/schemas/DistributionWidgetDefinition'
Expand Down
77 changes: 77 additions & 0 deletions docs/datadog_api_client.v1.model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,83 @@ datadog\_api\_client.v1.model.azure\_account\_list\_response module
:members:
:show-inheritance:

datadog\_api\_client.v1.model.bar\_chart\_widget\_definition module
-------------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.bar_chart_widget_definition
:members:
:show-inheritance:

datadog\_api\_client.v1.model.bar\_chart\_widget\_definition\_type module
-------------------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.bar_chart_widget_definition_type
:members:
:show-inheritance:

datadog\_api\_client.v1.model.bar\_chart\_widget\_display module
----------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.bar_chart_widget_display
:members:
:show-inheritance:

datadog\_api\_client.v1.model.bar\_chart\_widget\_flat module
-------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.bar_chart_widget_flat
:members:
:show-inheritance:

datadog\_api\_client.v1.model.bar\_chart\_widget\_flat\_type module
-------------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.bar_chart_widget_flat_type
:members:
:show-inheritance:

datadog\_api\_client.v1.model.bar\_chart\_widget\_legend module
---------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.bar_chart_widget_legend
:members:
:show-inheritance:

datadog\_api\_client.v1.model.bar\_chart\_widget\_request module
----------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.bar_chart_widget_request
:members:
:show-inheritance:

datadog\_api\_client.v1.model.bar\_chart\_widget\_scaling module
----------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.bar_chart_widget_scaling
:members:
:show-inheritance:

datadog\_api\_client.v1.model.bar\_chart\_widget\_stacked module
----------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.bar_chart_widget_stacked
:members:
:show-inheritance:

datadog\_api\_client.v1.model.bar\_chart\_widget\_stacked\_type module
----------------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.bar_chart_widget_stacked_type
:members:
:show-inheritance:

datadog\_api\_client.v1.model.bar\_chart\_widget\_style module
--------------------------------------------------------------

.. automodule:: datadog_api_client.v1.model.bar_chart_widget_style
:members:
:show-inheritance:

datadog\_api\_client.v1.model.cancel\_downtimes\_by\_scope\_request module
--------------------------------------------------------------------------

Expand Down
99 changes: 99 additions & 0 deletions examples/v1/dashboards/CreateDashboard_1712853070.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
"""
Create a new dashboard with bar_chart widget
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.bar_chart_widget_definition import BarChartWidgetDefinition
from datadog_api_client.v1.model.bar_chart_widget_definition_type import BarChartWidgetDefinitionType
from datadog_api_client.v1.model.bar_chart_widget_legend import BarChartWidgetLegend
from datadog_api_client.v1.model.bar_chart_widget_request import BarChartWidgetRequest
from datadog_api_client.v1.model.bar_chart_widget_scaling import BarChartWidgetScaling
from datadog_api_client.v1.model.bar_chart_widget_stacked import BarChartWidgetStacked
from datadog_api_client.v1.model.bar_chart_widget_stacked_type import BarChartWidgetStackedType
from datadog_api_client.v1.model.bar_chart_widget_style import BarChartWidgetStyle
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_metric_aggregation import FormulaAndFunctionMetricAggregation
from datadog_api_client.v1.model.formula_and_function_metric_data_source import FormulaAndFunctionMetricDataSource
from datadog_api_client.v1.model.formula_and_function_metric_query_definition import (
FormulaAndFunctionMetricQueryDefinition,
)
from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
from datadog_api_client.v1.model.formula_type import FormulaType
from datadog_api_client.v1.model.widget import Widget
from datadog_api_client.v1.model.widget_formula import WidgetFormula
from datadog_api_client.v1.model.widget_formula_sort import WidgetFormulaSort
from datadog_api_client.v1.model.widget_layout import WidgetLayout
from datadog_api_client.v1.model.widget_legacy_live_span import WidgetLegacyLiveSpan
from datadog_api_client.v1.model.widget_sort import WidgetSort
from datadog_api_client.v1.model.widget_sort_by import WidgetSortBy
from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign

body = Dashboard(
title="Example-Dashboard",
description="",
widgets=[
Widget(
layout=WidgetLayout(
x=0,
y=0,
width=47,
height=15,
),
definition=BarChartWidgetDefinition(
title="",
title_size="16",
title_align=WidgetTextAlign.LEFT,
time=WidgetLegacyLiveSpan(),
style=BarChartWidgetStyle(
display=BarChartWidgetStacked(
type=BarChartWidgetStackedType.STACKED,
legend=BarChartWidgetLegend.INLINE,
),
scaling=BarChartWidgetScaling.RELATIVE,
palette="dog_classic",
),
type=BarChartWidgetDefinitionType.BAR_CHART,
requests=[
BarChartWidgetRequest(
queries=[
FormulaAndFunctionMetricQueryDefinition(
data_source=FormulaAndFunctionMetricDataSource.METRICS,
name="query1",
query="avg:system.cpu.user{*} by {service}",
aggregator=FormulaAndFunctionMetricAggregation.AVG,
),
],
formulas=[
WidgetFormula(
formula="query1",
),
],
sort=WidgetSortBy(
count=10,
order_by=[
WidgetFormulaSort(
type=FormulaType.FORMULA,
index=0,
order=WidgetSort.DESCENDING,
),
],
),
response_format=FormulaAndFunctionResponseFormat.SCALAR,
),
],
),
),
],
template_variables=[],
layout_type=DashboardLayoutType.FREE,
notify_list=[],
)

configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardsApi(api_client)
response = api_instance.create_dashboard(body=body)

print(response)
Loading