DEPRECATED: Whether this dashboard is read-only. If True, only the author and admins can make changes to it. Prefer using restricted_roles to manage write authorization.
layout_type [required]
enum
Layout type of the dashboard.
Allowed enum values: ordered,free
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
reflow_type
enum
Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'.
If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto',
widgets should not have layouts.
Allowed enum values: auto,fixed
restricted_roles
[string]
A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
template_variable_presets
[object]
Array of template variables saved views.
name
string
The name of the variable.
template_variables
[object]
List of variables.
name
string
The name of the variable.
value
string
The value of the template variable within the saved view.
template_variables
[object]
List of template variables for this dashboard.
available_values
[string]
The list of values that the template variable drop-down is limited to.
default
string
The default value for the template variable on dashboard load.
name [required]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
The layout for a widget on a free or new dashboard layout dashboard.
height [required]
int64
The height of the widget. Should be a non-negative integer.
is_column_break
boolean
Whether the widget should be the first one on the second column in high density or not.
Note: Only for the new dashboard layout and only one widget in the dashboard should have this property set to true.
width [required]
int64
The width of the widget. Should be a non-negative integer.
x [required]
int64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
int64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
A dashboard is Datadog’s tool for visually tracking, analyzing, and displaying
key performance metrics, which enable you to monitor the health of your infrastructure.
Expand All
フィールド
種類
説明
author_handle
string
Identifier of the dashboard author.
author_name
string
Name of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
ID of the dashboard.
is_read_only
boolean
DEPRECATED: Whether this dashboard is read-only. If True, only the author and admins can make changes to it. Prefer using restricted_roles to manage write authorization.
layout_type [required]
enum
Layout type of the dashboard.
Allowed enum values: ordered,free
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
reflow_type
enum
Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'.
If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto',
widgets should not have layouts.
Allowed enum values: auto,fixed
restricted_roles
[string]
A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
template_variable_presets
[object]
Array of template variables saved views.
name
string
The name of the variable.
template_variables
[object]
List of variables.
name
string
The name of the variable.
value
string
The value of the template variable within the saved view.
template_variables
[object]
List of template variables for this dashboard.
available_values
[string]
The list of values that the template variable drop-down is limited to.
default
string
The default value for the template variable on dashboard load.
name [required]
string
The name of the variable.
prefix
string
The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down.
The layout for a widget on a free or new dashboard layout dashboard.
height [required]
int64
The height of the widget. Should be a non-negative integer.
is_column_break
boolean
Whether the widget should be the first one on the second column in high density or not.
Note: Only for the new dashboard layout and only one widget in the dashboard should have this property set to true.
width [required]
int64
The width of the widget. Should be a non-negative integer.
x [required]
int64
The position of the widget on the x (horizontal) axis. Should be a non-negative integer.
y [required]
int64
The position of the widget on the y (vertical) axis. Should be a non-negative integer.
// Create a distribution widget using a histogram request containing a formulas and functions APM Stats query
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/common"datadog"github.com/DataDog/datadog-api-client-go/v2/api/v1/datadog")funcmain(){body:=datadog.Dashboard{Title:"Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_APM_Stats",Description:*common.NewNullableString(common.PtrString("")),Widgets:[]datadog.Widget{{Definition:datadog.WidgetDefinition{DistributionWidgetDefinition:&datadog.DistributionWidgetDefinition{Title:common.PtrString("APM Stats - Request latency HOP"),TitleSize:common.PtrString("16"),TitleAlign:datadog.WIDGETTEXTALIGN_LEFT.Ptr(),ShowLegend:common.PtrBool(false),Type:datadog.DISTRIBUTIONWIDGETDEFINITIONTYPE_DISTRIBUTION,Xaxis:&datadog.DistributionWidgetXAxis{Max:common.PtrString("auto"),IncludeZero:common.PtrBool(true),Scale:common.PtrString("linear"),Min:common.PtrString("auto"),},Yaxis:&datadog.DistributionWidgetYAxis{Max:common.PtrString("auto"),IncludeZero:common.PtrBool(true),Scale:common.PtrString("linear"),Min:common.PtrString("auto"),},Requests:[]datadog.DistributionWidgetRequest{{Query:&datadog.DistributionWidgetHistogramRequestQuery{FormulaAndFunctionApmResourceStatsQueryDefinition:&datadog.FormulaAndFunctionApmResourceStatsQueryDefinition{PrimaryTagValue:common.PtrString("*"),Stat:datadog.FORMULAANDFUNCTIONAPMRESOURCESTATNAME_LATENCY_DISTRIBUTION,DataSource:datadog.FORMULAANDFUNCTIONAPMRESOURCESTATSDATASOURCE_APM_RESOURCE_STATS,Name:"query1",Service:"azure-bill-import",GroupBy:[]string{"resource_name",},Env:"staging",PrimaryTagName:common.PtrString("datacenter"),OperationName:common.PtrString("universal.http.client"),}},RequestType:datadog.DISTRIBUTIONWIDGETHISTOGRAMREQUESTTYPE_HISTOGRAM.Ptr(),Style:&datadog.WidgetStyle{Palette:common.PtrString("dog_classic"),},},},}},Layout:&datadog.WidgetLayout{X:8,Y:0,Width:4,Height:2,},},},LayoutType:datadog.DASHBOARDLAYOUTTYPE_ORDERED,}ctx:=common.NewDefaultContext(context.Background())configuration:=common.NewConfiguration()apiClient:=common.NewAPIClient(configuration)api:=datadog.NewDashboardsApi(apiClient)resp,r,err:=api.CreateDashboard(ctx,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DashboardsApi.CreateDashboard`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `DashboardsApi.CreateDashboard`:\n%s\n",responseContent)}
// Create a distribution widget using a histogram request containing a formulas and functions events query
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/common"datadog"github.com/DataDog/datadog-api-client-go/v2/api/v1/datadog")funcmain(){body:=datadog.Dashboard{Title:"Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_events_qu",Description:*common.NewNullableString(common.PtrString("Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_events_qu")),Widgets:[]datadog.Widget{{Definition:datadog.WidgetDefinition{DistributionWidgetDefinition:&datadog.DistributionWidgetDefinition{Title:common.PtrString("Events Platform - Request latency HOP"),TitleSize:common.PtrString("16"),TitleAlign:datadog.WIDGETTEXTALIGN_LEFT.Ptr(),ShowLegend:common.PtrBool(false),Type:datadog.DISTRIBUTIONWIDGETDEFINITIONTYPE_DISTRIBUTION,Xaxis:&datadog.DistributionWidgetXAxis{Max:common.PtrString("auto"),IncludeZero:common.PtrBool(true),Scale:common.PtrString("linear"),Min:common.PtrString("auto"),},Yaxis:&datadog.DistributionWidgetYAxis{Max:common.PtrString("auto"),IncludeZero:common.PtrBool(true),Scale:common.PtrString("linear"),Min:common.PtrString("auto"),},Requests:[]datadog.DistributionWidgetRequest{{Query:&datadog.DistributionWidgetHistogramRequestQuery{FormulaAndFunctionEventQueryDefinition:&datadog.FormulaAndFunctionEventQueryDefinition{Search:&datadog.FormulaAndFunctionEventQueryDefinitionSearch{Query:"",},DataSource:datadog.FORMULAANDFUNCTIONEVENTSDATASOURCE_EVENTS,Compute:datadog.FormulaAndFunctionEventQueryDefinitionCompute{Metric:common.PtrString("@duration"),Aggregation:datadog.FORMULAANDFUNCTIONEVENTAGGREGATION_MIN,},Name:"query1",Indexes:[]string{"*",},GroupBy:[]datadog.FormulaAndFunctionEventQueryGroupBy{},}},RequestType:datadog.DISTRIBUTIONWIDGETHISTOGRAMREQUESTTYPE_HISTOGRAM.Ptr(),},},}},Layout:&datadog.WidgetLayout{X:0,Y:0,Width:4,Height:2,},},},LayoutType:datadog.DASHBOARDLAYOUTTYPE_ORDERED,}ctx:=common.NewDefaultContext(context.Background())configuration:=common.NewConfiguration()apiClient:=common.NewAPIClient(configuration)api:=datadog.NewDashboardsApi(apiClient)resp,r,err:=api.CreateDashboard(ctx,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DashboardsApi.CreateDashboard`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `DashboardsApi.CreateDashboard`:\n%s\n",responseContent)}
// Create a distribution widget using a histogram request containing a formulas and functions metrics query
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/common"datadog"github.com/DataDog/datadog-api-client-go/v2/api/v1/datadog")funcmain(){body:=datadog.Dashboard{Title:"Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_metrics_q",Widgets:[]datadog.Widget{{Definition:datadog.WidgetDefinition{DistributionWidgetDefinition:&datadog.DistributionWidgetDefinition{Title:common.PtrString("Metrics HOP"),TitleSize:common.PtrString("16"),TitleAlign:datadog.WIDGETTEXTALIGN_LEFT.Ptr(),ShowLegend:common.PtrBool(false),Type:datadog.DISTRIBUTIONWIDGETDEFINITIONTYPE_DISTRIBUTION,Xaxis:&datadog.DistributionWidgetXAxis{Max:common.PtrString("auto"),IncludeZero:common.PtrBool(true),Scale:common.PtrString("linear"),Min:common.PtrString("auto"),},Yaxis:&datadog.DistributionWidgetYAxis{Max:common.PtrString("auto"),IncludeZero:common.PtrBool(true),Scale:common.PtrString("linear"),Min:common.PtrString("auto"),},Requests:[]datadog.DistributionWidgetRequest{{Query:&datadog.DistributionWidgetHistogramRequestQuery{FormulaAndFunctionMetricQueryDefinition:&datadog.FormulaAndFunctionMetricQueryDefinition{Query:"histogram:trace.Load{*}",DataSource:datadog.FORMULAANDFUNCTIONMETRICDATASOURCE_METRICS,Name:"query1",}},RequestType:datadog.DISTRIBUTIONWIDGETHISTOGRAMREQUESTTYPE_HISTOGRAM.Ptr(),Style:&datadog.WidgetStyle{Palette:common.PtrString("dog_classic"),},},},}},Layout:&datadog.WidgetLayout{X:0,Y:0,Width:4,Height:2,},},},LayoutType:datadog.DASHBOARDLAYOUTTYPE_ORDERED,}ctx:=common.NewDefaultContext(context.Background())configuration:=common.NewConfiguration()apiClient:=common.NewAPIClient(configuration)api:=datadog.NewDashboardsApi(apiClient)resp,r,err:=api.CreateDashboard(ctx,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DashboardsApi.CreateDashboard`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `DashboardsApi.CreateDashboard`:\n%s\n",responseContent)}
// Create a distribution widget using a histogram request containing a formulas and functions APM
// Stats query
importcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.DashboardsApi;importcom.datadog.api.client.v1.model.Dashboard;importcom.datadog.api.client.v1.model.DashboardLayoutType;importcom.datadog.api.client.v1.model.DistributionWidgetDefinition;importcom.datadog.api.client.v1.model.DistributionWidgetDefinitionType;importcom.datadog.api.client.v1.model.DistributionWidgetHistogramRequestQuery;importcom.datadog.api.client.v1.model.DistributionWidgetHistogramRequestType;importcom.datadog.api.client.v1.model.DistributionWidgetRequest;importcom.datadog.api.client.v1.model.DistributionWidgetXAxis;importcom.datadog.api.client.v1.model.DistributionWidgetYAxis;importcom.datadog.api.client.v1.model.FormulaAndFunctionApmResourceStatName;importcom.datadog.api.client.v1.model.FormulaAndFunctionApmResourceStatsDataSource;importcom.datadog.api.client.v1.model.FormulaAndFunctionApmResourceStatsQueryDefinition;importcom.datadog.api.client.v1.model.Widget;importcom.datadog.api.client.v1.model.WidgetDefinition;importcom.datadog.api.client.v1.model.WidgetLayout;importcom.datadog.api.client.v1.model.WidgetStyle;importcom.datadog.api.client.v1.model.WidgetTextAlign;importjava.util.Collections;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DashboardsApiapiInstance=newDashboardsApi(defaultClient);Dashboardbody=newDashboard().title("Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_APM_Stats").description("").widgets(Collections.singletonList(newWidget().definition(newWidgetDefinition(newDistributionWidgetDefinition().title("APM Stats - Request latency HOP").titleSize("16").titleAlign(WidgetTextAlign.LEFT).showLegend(false).type(DistributionWidgetDefinitionType.DISTRIBUTION).xaxis(newDistributionWidgetXAxis().max("auto").includeZero(true).scale("linear").min("auto")).yaxis(newDistributionWidgetYAxis().max("auto").includeZero(true).scale("linear").min("auto")).requests(Collections.singletonList(newDistributionWidgetRequest().query(newDistributionWidgetHistogramRequestQuery(newFormulaAndFunctionApmResourceStatsQueryDefinition().primaryTagValue("*").stat(FormulaAndFunctionApmResourceStatName.LATENCY_DISTRIBUTION).dataSource(FormulaAndFunctionApmResourceStatsDataSource.APM_RESOURCE_STATS).name("query1").service("azure-bill-import").groupBy(Collections.singletonList("resource_name")).env("staging").primaryTagName("datacenter").operationName("universal.http.client"))).requestType(DistributionWidgetHistogramRequestType.HISTOGRAM).style(newWidgetStyle().palette("dog_classic")))))).layout(newWidgetLayout().x(8L).y(0L).width(4L).height(2L)))).layoutType(DashboardLayoutType.ORDERED);try{Dashboardresult=apiInstance.createDashboard(body);System.out.println(result);}catch(ApiExceptione){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();}}}
// Create a distribution widget using a histogram request containing a formulas and functions events
// query
importcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.DashboardsApi;importcom.datadog.api.client.v1.model.Dashboard;importcom.datadog.api.client.v1.model.DashboardLayoutType;importcom.datadog.api.client.v1.model.DistributionWidgetDefinition;importcom.datadog.api.client.v1.model.DistributionWidgetDefinitionType;importcom.datadog.api.client.v1.model.DistributionWidgetHistogramRequestQuery;importcom.datadog.api.client.v1.model.DistributionWidgetHistogramRequestType;importcom.datadog.api.client.v1.model.DistributionWidgetRequest;importcom.datadog.api.client.v1.model.DistributionWidgetXAxis;importcom.datadog.api.client.v1.model.DistributionWidgetYAxis;importcom.datadog.api.client.v1.model.FormulaAndFunctionEventAggregation;importcom.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinition;importcom.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionCompute;importcom.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionSearch;importcom.datadog.api.client.v1.model.FormulaAndFunctionEventsDataSource;importcom.datadog.api.client.v1.model.Widget;importcom.datadog.api.client.v1.model.WidgetDefinition;importcom.datadog.api.client.v1.model.WidgetLayout;importcom.datadog.api.client.v1.model.WidgetTextAlign;importjava.util.Collections;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DashboardsApiapiInstance=newDashboardsApi(defaultClient);Dashboardbody=newDashboard().title("Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_events_qu").description("Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_events_qu").widgets(Collections.singletonList(newWidget().definition(newWidgetDefinition(newDistributionWidgetDefinition().title("Events Platform - Request latency HOP").titleSize("16").titleAlign(WidgetTextAlign.LEFT).showLegend(false).type(DistributionWidgetDefinitionType.DISTRIBUTION).xaxis(newDistributionWidgetXAxis().max("auto").includeZero(true).scale("linear").min("auto")).yaxis(newDistributionWidgetYAxis().max("auto").includeZero(true).scale("linear").min("auto")).requests(Collections.singletonList(newDistributionWidgetRequest().query(newDistributionWidgetHistogramRequestQuery(newFormulaAndFunctionEventQueryDefinition().search(newFormulaAndFunctionEventQueryDefinitionSearch().query("")).dataSource(FormulaAndFunctionEventsDataSource.EVENTS).compute(newFormulaAndFunctionEventQueryDefinitionCompute().metric("@duration").aggregation(FormulaAndFunctionEventAggregation.MIN)).name("query1").indexes(Collections.singletonList("*")))).requestType(DistributionWidgetHistogramRequestType.HISTOGRAM))))).layout(newWidgetLayout().x(0L).y(0L).width(4L).height(2L)))).layoutType(DashboardLayoutType.ORDERED);try{Dashboardresult=apiInstance.createDashboard(body);System.out.println(result);}catch(ApiExceptione){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();}}}
// Create a distribution widget using a histogram request containing a formulas and functions
// metrics query
importcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.DashboardsApi;importcom.datadog.api.client.v1.model.Dashboard;importcom.datadog.api.client.v1.model.DashboardLayoutType;importcom.datadog.api.client.v1.model.DistributionWidgetDefinition;importcom.datadog.api.client.v1.model.DistributionWidgetDefinitionType;importcom.datadog.api.client.v1.model.DistributionWidgetHistogramRequestQuery;importcom.datadog.api.client.v1.model.DistributionWidgetHistogramRequestType;importcom.datadog.api.client.v1.model.DistributionWidgetRequest;importcom.datadog.api.client.v1.model.DistributionWidgetXAxis;importcom.datadog.api.client.v1.model.DistributionWidgetYAxis;importcom.datadog.api.client.v1.model.FormulaAndFunctionMetricDataSource;importcom.datadog.api.client.v1.model.FormulaAndFunctionMetricQueryDefinition;importcom.datadog.api.client.v1.model.Widget;importcom.datadog.api.client.v1.model.WidgetDefinition;importcom.datadog.api.client.v1.model.WidgetLayout;importcom.datadog.api.client.v1.model.WidgetStyle;importcom.datadog.api.client.v1.model.WidgetTextAlign;importjava.util.Collections;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DashboardsApiapiInstance=newDashboardsApi(defaultClient);Dashboardbody=newDashboard().title("Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_metrics_q").widgets(Collections.singletonList(newWidget().definition(newWidgetDefinition(newDistributionWidgetDefinition().title("Metrics HOP").titleSize("16").titleAlign(WidgetTextAlign.LEFT).showLegend(false).type(DistributionWidgetDefinitionType.DISTRIBUTION).xaxis(newDistributionWidgetXAxis().max("auto").includeZero(true).scale("linear").min("auto")).yaxis(newDistributionWidgetYAxis().max("auto").includeZero(true).scale("linear").min("auto")).requests(Collections.singletonList(newDistributionWidgetRequest().query(newDistributionWidgetHistogramRequestQuery(newFormulaAndFunctionMetricQueryDefinition().query("histogram:trace.Load{*}").dataSource(FormulaAndFunctionMetricDataSource.METRICS).name("query1"))).requestType(DistributionWidgetHistogramRequestType.HISTOGRAM).style(newWidgetStyle().palette("dog_classic")))))).layout(newWidgetLayout().x(0L).y(0L).width(4L).height(2L)))).layoutType(DashboardLayoutType.ORDERED);try{Dashboardresult=apiInstance.createDashboard(body);System.out.println(result);}catch(ApiExceptione){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();}}}
"""
Create a distribution widget using a histogram request containing a formulas and functions APM Stats query
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.dashboards_apiimportDashboardsApifromdatadog_api_client.v1.model.dashboardimportDashboardfromdatadog_api_client.v1.model.dashboard_layout_typeimportDashboardLayoutTypefromdatadog_api_client.v1.model.distribution_widget_definitionimportDistributionWidgetDefinitionfromdatadog_api_client.v1.model.distribution_widget_definition_typeimportDistributionWidgetDefinitionTypefromdatadog_api_client.v1.model.distribution_widget_histogram_request_typeimport(DistributionWidgetHistogramRequestType,)fromdatadog_api_client.v1.model.distribution_widget_requestimportDistributionWidgetRequestfromdatadog_api_client.v1.model.distribution_widget_x_axisimportDistributionWidgetXAxisfromdatadog_api_client.v1.model.distribution_widget_y_axisimportDistributionWidgetYAxisfromdatadog_api_client.v1.model.formula_and_function_apm_resource_stat_nameimport(FormulaAndFunctionApmResourceStatName,)fromdatadog_api_client.v1.model.formula_and_function_apm_resource_stats_data_sourceimport(FormulaAndFunctionApmResourceStatsDataSource,)fromdatadog_api_client.v1.model.formula_and_function_apm_resource_stats_query_definitionimport(FormulaAndFunctionApmResourceStatsQueryDefinition,)fromdatadog_api_client.v1.model.widgetimportWidgetfromdatadog_api_client.v1.model.widget_layoutimportWidgetLayoutfromdatadog_api_client.v1.model.widget_styleimportWidgetStylefromdatadog_api_client.v1.model.widget_text_alignimportWidgetTextAlignbody=Dashboard(title="Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_APM_Stats",description="",widgets=[Widget(definition=DistributionWidgetDefinition(title="APM Stats - Request latency HOP",title_size="16",title_align=WidgetTextAlign("left"),show_legend=False,type=DistributionWidgetDefinitionType("distribution"),xaxis=DistributionWidgetXAxis(max="auto",include_zero=True,scale="linear",min="auto",),yaxis=DistributionWidgetYAxis(max="auto",include_zero=True,scale="linear",min="auto",),requests=[DistributionWidgetRequest(query=FormulaAndFunctionApmResourceStatsQueryDefinition(primary_tag_value="*",stat=FormulaAndFunctionApmResourceStatName("latency_distribution"),data_source=FormulaAndFunctionApmResourceStatsDataSource("apm_resource_stats"),name="query1",service="azure-bill-import",group_by=["resource_name",],env="staging",primary_tag_name="datacenter",operation_name="universal.http.client",),request_type=DistributionWidgetHistogramRequestType("histogram"),style=WidgetStyle(palette="dog_classic",),),],),layout=WidgetLayout(x=8,y=0,width=4,height=2,),),],layout_type=DashboardLayoutType("ordered"),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=DashboardsApi(api_client)response=api_instance.create_dashboard(body=body)print(response)
"""
Create a distribution widget using a histogram request containing a formulas and functions events query
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.dashboards_apiimportDashboardsApifromdatadog_api_client.v1.model.dashboardimportDashboardfromdatadog_api_client.v1.model.dashboard_layout_typeimportDashboardLayoutTypefromdatadog_api_client.v1.model.distribution_widget_definitionimportDistributionWidgetDefinitionfromdatadog_api_client.v1.model.distribution_widget_definition_typeimportDistributionWidgetDefinitionTypefromdatadog_api_client.v1.model.distribution_widget_histogram_request_typeimport(DistributionWidgetHistogramRequestType,)fromdatadog_api_client.v1.model.distribution_widget_requestimportDistributionWidgetRequestfromdatadog_api_client.v1.model.distribution_widget_x_axisimportDistributionWidgetXAxisfromdatadog_api_client.v1.model.distribution_widget_y_axisimportDistributionWidgetYAxisfromdatadog_api_client.v1.model.formula_and_function_event_aggregationimportFormulaAndFunctionEventAggregationfromdatadog_api_client.v1.model.formula_and_function_event_query_definitionimport(FormulaAndFunctionEventQueryDefinition,)fromdatadog_api_client.v1.model.formula_and_function_event_query_definition_computeimport(FormulaAndFunctionEventQueryDefinitionCompute,)fromdatadog_api_client.v1.model.formula_and_function_event_query_definition_searchimport(FormulaAndFunctionEventQueryDefinitionSearch,)fromdatadog_api_client.v1.model.formula_and_function_events_data_sourceimportFormulaAndFunctionEventsDataSourcefromdatadog_api_client.v1.model.widgetimportWidgetfromdatadog_api_client.v1.model.widget_layoutimportWidgetLayoutfromdatadog_api_client.v1.model.widget_text_alignimportWidgetTextAlignbody=Dashboard(title="Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_events_qu",description="Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_events_qu",widgets=[Widget(definition=DistributionWidgetDefinition(title="Events Platform - Request latency HOP",title_size="16",title_align=WidgetTextAlign("left"),show_legend=False,type=DistributionWidgetDefinitionType("distribution"),xaxis=DistributionWidgetXAxis(max="auto",include_zero=True,scale="linear",min="auto",),yaxis=DistributionWidgetYAxis(max="auto",include_zero=True,scale="linear",min="auto",),requests=[DistributionWidgetRequest(query=FormulaAndFunctionEventQueryDefinition(search=FormulaAndFunctionEventQueryDefinitionSearch(query="",),data_source=FormulaAndFunctionEventsDataSource("events"),compute=FormulaAndFunctionEventQueryDefinitionCompute(metric="@duration",aggregation=FormulaAndFunctionEventAggregation("min"),),name="query1",indexes=["*",],group_by=[],),request_type=DistributionWidgetHistogramRequestType("histogram"),),],),layout=WidgetLayout(x=0,y=0,width=4,height=2,),),],layout_type=DashboardLayoutType("ordered"),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=DashboardsApi(api_client)response=api_instance.create_dashboard(body=body)print(response)
"""
Create a distribution widget using a histogram request containing a formulas and functions metrics query
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.dashboards_apiimportDashboardsApifromdatadog_api_client.v1.model.dashboardimportDashboardfromdatadog_api_client.v1.model.dashboard_layout_typeimportDashboardLayoutTypefromdatadog_api_client.v1.model.distribution_widget_definitionimportDistributionWidgetDefinitionfromdatadog_api_client.v1.model.distribution_widget_definition_typeimportDistributionWidgetDefinitionTypefromdatadog_api_client.v1.model.distribution_widget_histogram_request_typeimport(DistributionWidgetHistogramRequestType,)fromdatadog_api_client.v1.model.distribution_widget_requestimportDistributionWidgetRequestfromdatadog_api_client.v1.model.distribution_widget_x_axisimportDistributionWidgetXAxisfromdatadog_api_client.v1.model.distribution_widget_y_axisimportDistributionWidgetYAxisfromdatadog_api_client.v1.model.formula_and_function_metric_data_sourceimportFormulaAndFunctionMetricDataSourcefromdatadog_api_client.v1.model.formula_and_function_metric_query_definitionimport(FormulaAndFunctionMetricQueryDefinition,)fromdatadog_api_client.v1.model.widgetimportWidgetfromdatadog_api_client.v1.model.widget_layoutimportWidgetLayoutfromdatadog_api_client.v1.model.widget_styleimportWidgetStylefromdatadog_api_client.v1.model.widget_text_alignimportWidgetTextAlignbody=Dashboard(title="Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_metrics_q",widgets=[Widget(definition=DistributionWidgetDefinition(title="Metrics HOP",title_size="16",title_align=WidgetTextAlign("left"),show_legend=False,type=DistributionWidgetDefinitionType("distribution"),xaxis=DistributionWidgetXAxis(max="auto",include_zero=True,scale="linear",min="auto",),yaxis=DistributionWidgetYAxis(max="auto",include_zero=True,scale="linear",min="auto",),requests=[DistributionWidgetRequest(query=FormulaAndFunctionMetricQueryDefinition(query="histogram:trace.Load{*}",data_source=FormulaAndFunctionMetricDataSource("metrics"),name="query1",),request_type=DistributionWidgetHistogramRequestType("histogram"),style=WidgetStyle(palette="dog_classic",),),],),layout=WidgetLayout(x=0,y=0,width=4,height=2,),),],layout_type=DashboardLayoutType("ordered"),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=DashboardsApi(api_client)response=api_instance.create_dashboard(body=body)print(response)
# Create a distribution widget using a histogram request containing a formulas and functions APM Stats queryrequire"datadog_api_client"api_instance=DatadogAPIClient::V1::DashboardsAPI.newbody=DatadogAPIClient::V1::Dashboard.new({title:"Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_APM_Stats",description:"",widgets:[DatadogAPIClient::V1::Widget.new({definition:DatadogAPIClient::V1::DistributionWidgetDefinition.new({title:"APM Stats - Request latency HOP",title_size:"16",title_align:DatadogAPIClient::V1::WidgetTextAlign::LEFT,show_legend:false,type:DatadogAPIClient::V1::DistributionWidgetDefinitionType::DISTRIBUTION,xaxis:DatadogAPIClient::V1::DistributionWidgetXAxis.new({max:"auto",include_zero:true,scale:"linear",min:"auto",}),yaxis:DatadogAPIClient::V1::DistributionWidgetYAxis.new({max:"auto",include_zero:true,scale:"linear",min:"auto",}),requests:[DatadogAPIClient::V1::DistributionWidgetRequest.new({query:DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatsQueryDefinition.new({primary_tag_value:"*",stat:DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatName::LATENCY_DISTRIBUTION,data_source:DatadogAPIClient::V1::FormulaAndFunctionApmResourceStatsDataSource::APM_RESOURCE_STATS,name:"query1",service:"azure-bill-import",group_by:["resource_name",],env:"staging",primary_tag_name:"datacenter",operation_name:"universal.http.client",}),request_type:DatadogAPIClient::V1::DistributionWidgetHistogramRequestType::HISTOGRAM,style:DatadogAPIClient::V1::WidgetStyle.new({palette:"dog_classic",}),}),],}),layout:DatadogAPIClient::V1::WidgetLayout.new({x:8,y:0,width:4,height:2,}),}),],layout_type:DatadogAPIClient::V1::DashboardLayoutType::ORDERED,})papi_instance.create_dashboard(body)
# Create a distribution widget using a histogram request containing a formulas and functions events queryrequire"datadog_api_client"api_instance=DatadogAPIClient::V1::DashboardsAPI.newbody=DatadogAPIClient::V1::Dashboard.new({title:"Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_events_qu",description:"Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_events_qu",widgets:[DatadogAPIClient::V1::Widget.new({definition:DatadogAPIClient::V1::DistributionWidgetDefinition.new({title:"Events Platform - Request latency HOP",title_size:"16",title_align:DatadogAPIClient::V1::WidgetTextAlign::LEFT,show_legend:false,type:DatadogAPIClient::V1::DistributionWidgetDefinitionType::DISTRIBUTION,xaxis:DatadogAPIClient::V1::DistributionWidgetXAxis.new({max:"auto",include_zero:true,scale:"linear",min:"auto",}),yaxis:DatadogAPIClient::V1::DistributionWidgetYAxis.new({max:"auto",include_zero:true,scale:"linear",min:"auto",}),requests:[DatadogAPIClient::V1::DistributionWidgetRequest.new({query:DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinition.new({search:DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinitionSearch.new({query:"",}),data_source:DatadogAPIClient::V1::FormulaAndFunctionEventsDataSource::EVENTS,compute:DatadogAPIClient::V1::FormulaAndFunctionEventQueryDefinitionCompute.new({metric:"@duration",aggregation:DatadogAPIClient::V1::FormulaAndFunctionEventAggregation::MIN,}),name:"query1",indexes:["*",],group_by:[],}),request_type:DatadogAPIClient::V1::DistributionWidgetHistogramRequestType::HISTOGRAM,}),],}),layout:DatadogAPIClient::V1::WidgetLayout.new({x:0,y:0,width:4,height:2,}),}),],layout_type:DatadogAPIClient::V1::DashboardLayoutType::ORDERED,})papi_instance.create_dashboard(body)
# Create a distribution widget using a histogram request containing a formulas and functions metrics queryrequire"datadog_api_client"api_instance=DatadogAPIClient::V1::DashboardsAPI.newbody=DatadogAPIClient::V1::Dashboard.new({title:"Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_metrics_q",widgets:[DatadogAPIClient::V1::Widget.new({definition:DatadogAPIClient::V1::DistributionWidgetDefinition.new({title:"Metrics HOP",title_size:"16",title_align:DatadogAPIClient::V1::WidgetTextAlign::LEFT,show_legend:false,type:DatadogAPIClient::V1::DistributionWidgetDefinitionType::DISTRIBUTION,xaxis:DatadogAPIClient::V1::DistributionWidgetXAxis.new({max:"auto",include_zero:true,scale:"linear",min:"auto",}),yaxis:DatadogAPIClient::V1::DistributionWidgetYAxis.new({max:"auto",include_zero:true,scale:"linear",min:"auto",}),requests:[DatadogAPIClient::V1::DistributionWidgetRequest.new({query:DatadogAPIClient::V1::FormulaAndFunctionMetricQueryDefinition.new({query:"histogram:trace.Load{*}",data_source:DatadogAPIClient::V1::FormulaAndFunctionMetricDataSource::METRICS,name:"query1",}),request_type:DatadogAPIClient::V1::DistributionWidgetHistogramRequestType::HISTOGRAM,style:DatadogAPIClient::V1::WidgetStyle.new({palette:"dog_classic",}),}),],}),layout:DatadogAPIClient::V1::WidgetLayout.new({x:0,y:0,width:4,height:2,}),}),],layout_type:DatadogAPIClient::V1::DashboardLayoutType::ORDERED,})papi_instance.create_dashboard(body)
/**
* Create a distribution widget using a histogram request containing a formulas and functions APM Stats query
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.DashboardsApi(configuration);constparams: v1.DashboardsApiCreateDashboardRequest={body:{title:"Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_APM_Stats",description:"",widgets:[{definition:{title:"APM Stats - Request latency HOP",titleSize:"16",titleAlign:"left",showLegend: false,type:"distribution",xaxis:{max:"auto",includeZero: true,scale:"linear",min:"auto",},yaxis:{max:"auto",includeZero: true,scale:"linear",min:"auto",},requests:[{query:{primaryTagValue:"*",stat:"latency_distribution",dataSource:"apm_resource_stats",name:"query1",service:"azure-bill-import",groupBy:["resource_name"],env:"staging",primaryTagName:"datacenter",operationName:"universal.http.client",},requestType:"histogram",style:{palette:"dog_classic",},},],},layout:{x: 8,y: 0,width: 4,height: 2,},},],layoutType:"ordered",},};apiInstance.createDashboard(params).then((data: v1.Dashboard)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
/**
* Create a distribution widget using a histogram request containing a formulas and functions events query
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.DashboardsApi(configuration);constparams: v1.DashboardsApiCreateDashboardRequest={body:{title:"Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_events_qu",description:"Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_events_qu",widgets:[{definition:{title:"Events Platform - Request latency HOP",titleSize:"16",titleAlign:"left",showLegend: false,type:"distribution",xaxis:{max:"auto",includeZero: true,scale:"linear",min:"auto",},yaxis:{max:"auto",includeZero: true,scale:"linear",min:"auto",},requests:[{query:{search:{query:"",},dataSource:"events",compute:{metric:"@duration",aggregation:"min",},name:"query1",indexes:["*"],groupBy:[],},requestType:"histogram",},],},layout:{x: 0,y: 0,width: 4,height: 2,},},],layoutType:"ordered",},};apiInstance.createDashboard(params).then((data: v1.Dashboard)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
/**
* Create a distribution widget using a histogram request containing a formulas and functions metrics query
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.DashboardsApi(configuration);constparams: v1.DashboardsApiCreateDashboardRequest={body:{title:"Example-Create_a_distribution_widget_using_a_histogram_request_containing_a_formulas_and_functions_metrics_q",widgets:[{definition:{title:"Metrics HOP",titleSize:"16",titleAlign:"left",showLegend: false,type:"distribution",xaxis:{max:"auto",includeZero: true,scale:"linear",min:"auto",},yaxis:{max:"auto",includeZero: true,scale:"linear",min:"auto",},requests:[{query:{query:"histogram:trace.Load{*}",dataSource:"metrics",name:"query1",},requestType:"histogram",style:{palette:"dog_classic",},},],},layout:{x: 0,y: 0,width: 4,height: 2,},},],layoutType:"ordered",},};apiInstance.createDashboard(params).then((data: v1.Dashboard)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
// Get all dashboards returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/common"datadog"github.com/DataDog/datadog-api-client-go/v2/api/v1/datadog")funcmain(){ctx:=common.NewDefaultContext(context.Background())configuration:=common.NewConfiguration()apiClient:=common.NewAPIClient(configuration)api:=datadog.NewDashboardsApi(apiClient)resp,r,err:=api.ListDashboards(ctx,*datadog.NewListDashboardsOptionalParameters().WithFilterShared(false))iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DashboardsApi.ListDashboards`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `DashboardsApi.ListDashboards`:\n%s\n",responseContent)}
// Get deleted dashboards returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/common"datadog"github.com/DataDog/datadog-api-client-go/v2/api/v1/datadog")funcmain(){ctx:=common.NewDefaultContext(context.Background())configuration:=common.NewConfiguration()apiClient:=common.NewAPIClient(configuration)api:=datadog.NewDashboardsApi(apiClient)resp,r,err:=api.ListDashboards(ctx,*datadog.NewListDashboardsOptionalParameters().WithFilterDeleted(true))iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DashboardsApi.ListDashboards`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `DashboardsApi.ListDashboards`:\n%s\n",responseContent)}
"""
Get all dashboards returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.dashboards_apiimportDashboardsApiconfiguration=Configuration()withApiClient(configuration)asapi_client:api_instance=DashboardsApi(api_client)response=api_instance.list_dashboards(filter_shared=False,)print(response)
"""
Get deleted dashboards returns "OK" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.dashboards_apiimportDashboardsApiconfiguration=Configuration()withApiClient(configuration)asapi_client:api_instance=DashboardsApi(api_client)response=api_instance.list_dashboards(filter_deleted=True,)print(response)
# Get all dashboards returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::DashboardsAPI.newopts={filter_shared:false,}papi_instance.list_dashboards(opts)
# Get deleted dashboards returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::DashboardsAPI.newopts={filter_deleted:true,}papi_instance.list_dashboards(opts)
/**
* Get all dashboards returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.DashboardsApi(configuration);constparams: v1.DashboardsApiListDashboardsRequest={filterShared: false,};apiInstance.listDashboards(params).then((data: v1.DashboardSummary)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
/**
* Get deleted dashboards returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.DashboardsApi(configuration);constparams: v1.DashboardsApiListDashboardsRequest={filterDeleted: true,};apiInstance.listDashboards(params).then((data: v1.DashboardSummary)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
// Delete a dashboard returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/common"datadog"github.com/DataDog/datadog-api-client-go/v2/api/v1/datadog")funcmain(){// there is a valid "dashboard" in the system
DashboardID:=os.Getenv("DASHBOARD_ID")ctx:=common.NewDefaultContext(context.Background())configuration:=common.NewConfiguration()apiClient:=common.NewAPIClient(configuration)api:=datadog.NewDashboardsApi(apiClient)resp,r,err:=api.DeleteDashboard(ctx,DashboardID)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DashboardsApi.DeleteDashboard`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `DashboardsApi.DeleteDashboard`:\n%s\n",responseContent)}
// Delete a dashboard returns "OK" response
importcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.DashboardsApi;importcom.datadog.api.client.v1.model.DashboardDeleteResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DashboardsApiapiInstance=newDashboardsApi(defaultClient);// there is a valid "dashboard" in the system
StringDASHBOARD_ID=System.getenv("DASHBOARD_ID");try{DashboardDeleteResponseresult=apiInstance.deleteDashboard(DASHBOARD_ID);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling DashboardsApi#deleteDashboard");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Delete a dashboard returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.dashboards_apiimportDashboardsApi# there is a valid "dashboard" in the systemDASHBOARD_ID=environ["DASHBOARD_ID"]configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=DashboardsApi(api_client)response=api_instance.delete_dashboard(dashboard_id=DASHBOARD_ID,)print(response)
# Delete a dashboard returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::DashboardsAPI.new# there is a valid "dashboard" in the systemDASHBOARD_ID=ENV["DASHBOARD_ID"]papi_instance.delete_dashboard(DASHBOARD_ID)
/**
* Delete a dashboard returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.DashboardsApi(configuration);// there is a valid "dashboard" in the system
constDASHBOARD_ID=process.env.DASHBOARD_IDasstring;constparams: v1.DashboardsApiDeleteDashboardRequest={dashboardId: DASHBOARD_ID,};apiInstance.deleteDashboard(params).then((data: v1.DashboardDeleteResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
// Delete dashboards returns "No Content" response
packagemainimport("context""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/common"datadog"github.com/DataDog/datadog-api-client-go/v2/api/v1/datadog")funcmain(){// there is a valid "dashboard" in the system
DashboardID:=os.Getenv("DASHBOARD_ID")body:=datadog.DashboardBulkDeleteRequest{Data:[]datadog.DashboardBulkActionData{{Id:DashboardID,Type:datadog.DASHBOARDRESOURCETYPE_DASHBOARD,},},}ctx:=common.NewDefaultContext(context.Background())configuration:=common.NewConfiguration()apiClient:=common.NewAPIClient(configuration)api:=datadog.NewDashboardsApi(apiClient)r,err:=api.DeleteDashboards(ctx,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DashboardsApi.DeleteDashboards`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}}
// Delete dashboards returns "No Content" response
importcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.DashboardsApi;importcom.datadog.api.client.v1.model.DashboardBulkActionData;importcom.datadog.api.client.v1.model.DashboardBulkDeleteRequest;importcom.datadog.api.client.v1.model.DashboardResourceType;importjava.util.Collections;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DashboardsApiapiInstance=newDashboardsApi(defaultClient);// there is a valid "dashboard" in the system
StringDASHBOARD_ID=System.getenv("DASHBOARD_ID");DashboardBulkDeleteRequestbody=newDashboardBulkDeleteRequest().data(Collections.singletonList(newDashboardBulkActionData().id(DASHBOARD_ID).type(DashboardResourceType.DASHBOARD)));try{apiInstance.deleteDashboards(body);}catch(ApiExceptione){System.err.println("Exception when calling DashboardsApi#deleteDashboards");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Delete dashboards returns "No Content" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.dashboards_apiimportDashboardsApifromdatadog_api_client.v1.model.dashboard_bulk_action_dataimportDashboardBulkActionDatafromdatadog_api_client.v1.model.dashboard_bulk_action_data_listimportDashboardBulkActionDataListfromdatadog_api_client.v1.model.dashboard_bulk_delete_requestimportDashboardBulkDeleteRequestfromdatadog_api_client.v1.model.dashboard_resource_typeimportDashboardResourceType# there is a valid "dashboard" in the systemDASHBOARD_ID=environ["DASHBOARD_ID"]body=DashboardBulkDeleteRequest(data=DashboardBulkActionDataList([DashboardBulkActionData(id=DASHBOARD_ID,type=DashboardResourceType("dashboard"),),]),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=DashboardsApi(api_client)api_instance.delete_dashboards(body=body)
# Delete dashboards returns "No Content" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::DashboardsAPI.new# there is a valid "dashboard" in the systemDASHBOARD_ID=ENV["DASHBOARD_ID"]body=DatadogAPIClient::V1::DashboardBulkDeleteRequest.new({data:[DatadogAPIClient::V1::DashboardBulkActionData.new({id:DASHBOARD_ID,type:DatadogAPIClient::V1::DashboardResourceType::DASHBOARD,}),],})api_instance.delete_dashboards(body)
/**
* Delete dashboards returns "No Content" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.DashboardsApi(configuration);// there is a valid "dashboard" in the system
constDASHBOARD_ID=process.env.DASHBOARD_IDasstring;constparams: v1.DashboardsApiDeleteDashboardsRequest={body:{data:[{id: DASHBOARD_ID,type:"dashboard",},],},};apiInstance.deleteDashboards(params).then((data: any)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));