Gérez tous vos dashboards, ainsi que l’accès à vos dashboards partagés, par le biais de l’API. Consultez la page relative aux [dashboards]](https://docs.datadoghq.com/dashboards/) pour en savoir plus.
Créez un dashboard avec les options spécifiées. Lorsque vous définissez des requêtes dans vos widgets, repérez les requêtes pour lesquelles il faut ajouter les modificateurs as_count() ou as_rate().
Consultez la [documentation relative aux modificateurs intégrés à l’application] (https://docs.datadoghq.com/developers/metrics/type_modifiers/?tab=count#modificateurs-integres-a-l-application) pour en savoir plus.
This endpoint requires the dashboards_write permission.
OAuth apps require the dashboards_write authorization scope to access this endpoint.
DEPRECATED: Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
This property is deprecated; please use the Restriction Policies API instead to manage write authorization for individual dashboards.
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.
tags
[string]
List of team names representing ownership of a 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
DEPRECATED: (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with values.
values
[string]
One or many template variable values within the saved view, which will be unioned together using OR if more than one is specified. Cannot be used in conjunction with value.
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
DEPRECATED: (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with defaults.
defaults
[string]
One or many default values for template variables on load. If more than one default is specified, they will be unioned together with OR. Cannot be used in conjunction with default.
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.
type
string
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
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.
{"title":"Example-Dashboard","widgets":[{"definition":{"title":"Example Cloud Cost Query","title_size":"16","title_align":"left","type":"timeseries","requests":[{"formulas":[{"formula":"query1"}],"queries":[{"data_source":"cloud_cost","name":"query1","query":"sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)"}],"response_format":"timeseries","style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"bars"}],"time":{}}}],"layout_type":"ordered"}
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
Champ
Type
Description
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.
This property is deprecated; please use the Restriction Policies API instead to manage write authorization for individual dashboards.
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.
tags
[string]
List of team names representing ownership of a 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
DEPRECATED: (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with values.
values
[string]
One or many template variable values within the saved view, which will be unioned together using OR if more than one is specified. Cannot be used in conjunction with value.
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
DEPRECATED: (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with defaults.
defaults
[string]
One or many default values for template variables on load. If more than one default is specified, they will be unioned together with OR. Cannot be used in conjunction with default.
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.
type
string
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
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.
// Clients deserialize a dashboard with a empty time object
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){body:=datadogV1.Dashboard{Title:"Example-Dashboard",Widgets:[]datadogV1.Widget{{Definition:datadogV1.WidgetDefinition{TimeseriesWidgetDefinition:&datadogV1.TimeseriesWidgetDefinition{Title:datadog.PtrString("Example Cloud Cost Query"),TitleSize:datadog.PtrString("16"),TitleAlign:datadogV1.WIDGETTEXTALIGN_LEFT.Ptr(),Type:datadogV1.TIMESERIESWIDGETDEFINITIONTYPE_TIMESERIES,Requests:[]datadogV1.TimeseriesWidgetRequest{{Formulas:[]datadogV1.WidgetFormula{{Formula:"query1",},},Queries:[]datadogV1.FormulaAndFunctionQueryDefinition{datadogV1.FormulaAndFunctionQueryDefinition{FormulaAndFunctionCloudCostQueryDefinition:&datadogV1.FormulaAndFunctionCloudCostQueryDefinition{DataSource:datadogV1.FORMULAANDFUNCTIONCLOUDCOSTDATASOURCE_CLOUD_COST,Name:"query1",Query:"sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)",}},},ResponseFormat:datadogV1.FORMULAANDFUNCTIONRESPONSEFORMAT_TIMESERIES.Ptr(),Style:&datadogV1.WidgetRequestStyle{Palette:datadog.PtrString("dog_classic"),LineType:datadogV1.WIDGETLINETYPE_SOLID.Ptr(),LineWidth:datadogV1.WIDGETLINEWIDTH_NORMAL.Ptr(),},DisplayType:datadogV1.WIDGETDISPLAYTYPE_BARS.Ptr(),},},Time:&datadogV1.WidgetTime{WidgetLegacyLiveSpan:&datadogV1.WidgetLegacyLiveSpan{}},}},},},LayoutType:datadogV1.DASHBOARDLAYOUTTYPE_ORDERED,}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.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
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){body:=datadogV1.Dashboard{Title:"Example-Dashboard",Description:*datadog.NewNullableString(datadog.PtrString("")),Widgets:[]datadogV1.Widget{{Definition:datadogV1.WidgetDefinition{DistributionWidgetDefinition:&datadogV1.DistributionWidgetDefinition{Title:datadog.PtrString("APM Stats - Request latency HOP"),TitleSize:datadog.PtrString("16"),TitleAlign:datadogV1.WIDGETTEXTALIGN_LEFT.Ptr(),ShowLegend:datadog.PtrBool(false),Type:datadogV1.DISTRIBUTIONWIDGETDEFINITIONTYPE_DISTRIBUTION,Xaxis:&datadogV1.DistributionWidgetXAxis{Max:datadog.PtrString("auto"),IncludeZero:datadog.PtrBool(true),Scale:datadog.PtrString("linear"),Min:datadog.PtrString("auto"),},Yaxis:&datadogV1.DistributionWidgetYAxis{Max:datadog.PtrString("auto"),IncludeZero:datadog.PtrBool(true),Scale:datadog.PtrString("linear"),Min:datadog.PtrString("auto"),},Requests:[]datadogV1.DistributionWidgetRequest{{Query:&datadogV1.DistributionWidgetHistogramRequestQuery{FormulaAndFunctionApmResourceStatsQueryDefinition:&datadogV1.FormulaAndFunctionApmResourceStatsQueryDefinition{PrimaryTagValue:datadog.PtrString("*"),Stat:datadogV1.FORMULAANDFUNCTIONAPMRESOURCESTATNAME_LATENCY_DISTRIBUTION,DataSource:datadogV1.FORMULAANDFUNCTIONAPMRESOURCESTATSDATASOURCE_APM_RESOURCE_STATS,Name:"query1",Service:"azure-bill-import",GroupBy:[]string{"resource_name",},Env:"staging",PrimaryTagName:datadog.PtrString("datacenter"),OperationName:datadog.PtrString("universal.http.client"),}},RequestType:datadogV1.DISTRIBUTIONWIDGETHISTOGRAMREQUESTTYPE_HISTOGRAM.Ptr(),Style:&datadogV1.WidgetStyle{Palette:datadog.PtrString("dog_classic"),},},},}},Layout:&datadogV1.WidgetLayout{X:8,Y:0,Width:4,Height:2,},},},LayoutType:datadogV1.DASHBOARDLAYOUTTYPE_ORDERED,}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.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/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){body:=datadogV1.Dashboard{Title:"Example-Dashboard",Description:*datadog.NewNullableString(datadog.PtrString("Example-Dashboard")),Widgets:[]datadogV1.Widget{{Definition:datadogV1.WidgetDefinition{DistributionWidgetDefinition:&datadogV1.DistributionWidgetDefinition{Title:datadog.PtrString("Events Platform - Request latency HOP"),TitleSize:datadog.PtrString("16"),TitleAlign:datadogV1.WIDGETTEXTALIGN_LEFT.Ptr(),ShowLegend:datadog.PtrBool(false),Type:datadogV1.DISTRIBUTIONWIDGETDEFINITIONTYPE_DISTRIBUTION,Xaxis:&datadogV1.DistributionWidgetXAxis{Max:datadog.PtrString("auto"),IncludeZero:datadog.PtrBool(true),Scale:datadog.PtrString("linear"),Min:datadog.PtrString("auto"),},Yaxis:&datadogV1.DistributionWidgetYAxis{Max:datadog.PtrString("auto"),IncludeZero:datadog.PtrBool(true),Scale:datadog.PtrString("linear"),Min:datadog.PtrString("auto"),},Requests:[]datadogV1.DistributionWidgetRequest{{Query:&datadogV1.DistributionWidgetHistogramRequestQuery{FormulaAndFunctionEventQueryDefinition:&datadogV1.FormulaAndFunctionEventQueryDefinition{Search:&datadogV1.FormulaAndFunctionEventQueryDefinitionSearch{Query:"",},DataSource:datadogV1.FORMULAANDFUNCTIONEVENTSDATASOURCE_EVENTS,Compute:datadogV1.FormulaAndFunctionEventQueryDefinitionCompute{Metric:datadog.PtrString("@duration"),Aggregation:datadogV1.FORMULAANDFUNCTIONEVENTAGGREGATION_MIN,},Name:"query1",Indexes:[]string{"*",},GroupBy:[]datadogV1.FormulaAndFunctionEventQueryGroupBy{},}},RequestType:datadogV1.DISTRIBUTIONWIDGETHISTOGRAMREQUESTTYPE_HISTOGRAM.Ptr(),},},}},Layout:&datadogV1.WidgetLayout{X:0,Y:0,Width:4,Height:2,},},},LayoutType:datadogV1.DASHBOARDLAYOUTTYPE_ORDERED,}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.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)}
// Clients deserialize a dashboard with a empty time objectimportcom.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.FormulaAndFunctionCloudCostDataSource;importcom.datadog.api.client.v1.model.FormulaAndFunctionCloudCostQueryDefinition;importcom.datadog.api.client.v1.model.FormulaAndFunctionQueryDefinition;importcom.datadog.api.client.v1.model.FormulaAndFunctionResponseFormat;importcom.datadog.api.client.v1.model.TimeseriesWidgetDefinition;importcom.datadog.api.client.v1.model.TimeseriesWidgetDefinitionType;importcom.datadog.api.client.v1.model.TimeseriesWidgetRequest;importcom.datadog.api.client.v1.model.Widget;importcom.datadog.api.client.v1.model.WidgetDefinition;importcom.datadog.api.client.v1.model.WidgetDisplayType;importcom.datadog.api.client.v1.model.WidgetFormula;importcom.datadog.api.client.v1.model.WidgetLegacyLiveSpan;importcom.datadog.api.client.v1.model.WidgetLineType;importcom.datadog.api.client.v1.model.WidgetLineWidth;importcom.datadog.api.client.v1.model.WidgetRequestStyle;importcom.datadog.api.client.v1.model.WidgetTextAlign;importcom.datadog.api.client.v1.model.WidgetTime;importjava.util.Collections;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DashboardsApiapiInstance=newDashboardsApi(defaultClient);Dashboardbody=newDashboard().title("Example-Dashboard").widgets(Collections.singletonList(newWidget().definition(newWidgetDefinition(newTimeseriesWidgetDefinition().title("Example Cloud Cost Query").titleSize("16").titleAlign(WidgetTextAlign.LEFT).type(TimeseriesWidgetDefinitionType.TIMESERIES).requests(Collections.singletonList(newTimeseriesWidgetRequest().formulas(Collections.singletonList(newWidgetFormula().formula("query1"))).queries(Collections.singletonList(newFormulaAndFunctionQueryDefinition(newFormulaAndFunctionCloudCostQueryDefinition().dataSource(FormulaAndFunctionCloudCostDataSource.CLOUD_COST).name("query1").query("sum:aws.cost.amortized{*} by"+" {aws_product}.rollup(sum,"+" monthly)")))).responseFormat(FormulaAndFunctionResponseFormat.TIMESERIES).style(newWidgetRequestStyle().palette("dog_classic").lineType(WidgetLineType.SOLID).lineWidth(WidgetLineWidth.NORMAL)).displayType(WidgetDisplayType.BARS))).time(newWidgetTime(newWidgetLegacyLiveSpan())))))).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 queryimportcom.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-Dashboard").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// queryimportcom.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-Dashboard").description("Example-Dashboard").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();}}}
"""
Clients deserialize a dashboard with a empty time object
"""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.formula_and_function_cloud_cost_data_sourceimport(FormulaAndFunctionCloudCostDataSource,)fromdatadog_api_client.v1.model.formula_and_function_cloud_cost_query_definitionimport(FormulaAndFunctionCloudCostQueryDefinition,)fromdatadog_api_client.v1.model.formula_and_function_response_formatimportFormulaAndFunctionResponseFormatfromdatadog_api_client.v1.model.timeseries_widget_definitionimportTimeseriesWidgetDefinitionfromdatadog_api_client.v1.model.timeseries_widget_definition_typeimportTimeseriesWidgetDefinitionTypefromdatadog_api_client.v1.model.timeseries_widget_requestimportTimeseriesWidgetRequestfromdatadog_api_client.v1.model.widgetimportWidgetfromdatadog_api_client.v1.model.widget_display_typeimportWidgetDisplayTypefromdatadog_api_client.v1.model.widget_formulaimportWidgetFormulafromdatadog_api_client.v1.model.widget_legacy_live_spanimportWidgetLegacyLiveSpanfromdatadog_api_client.v1.model.widget_line_typeimportWidgetLineTypefromdatadog_api_client.v1.model.widget_line_widthimportWidgetLineWidthfromdatadog_api_client.v1.model.widget_request_styleimportWidgetRequestStylefromdatadog_api_client.v1.model.widget_text_alignimportWidgetTextAlignbody=Dashboard(title="Example-Dashboard",widgets=[Widget(definition=TimeseriesWidgetDefinition(title="Example Cloud Cost Query",title_size="16",title_align=WidgetTextAlign.LEFT,type=TimeseriesWidgetDefinitionType.TIMESERIES,requests=[TimeseriesWidgetRequest(formulas=[WidgetFormula(formula="query1",),],queries=[FormulaAndFunctionCloudCostQueryDefinition(data_source=FormulaAndFunctionCloudCostDataSource.CLOUD_COST,name="query1",query="sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)",),],response_format=FormulaAndFunctionResponseFormat.TIMESERIES,style=WidgetRequestStyle(palette="dog_classic",line_type=WidgetLineType.SOLID,line_width=WidgetLineWidth.NORMAL,),display_type=WidgetDisplayType.BARS,),],time=WidgetLegacyLiveSpan(),),),],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 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-Dashboard",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-Dashboard",description="Example-Dashboard",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)
# Clients deserialize a dashboard with a empty time objectrequire"datadog_api_client"api_instance=DatadogAPIClient::V1::DashboardsAPI.newbody=DatadogAPIClient::V1::Dashboard.new({title:"Example-Dashboard",widgets:[DatadogAPIClient::V1::Widget.new({definition:DatadogAPIClient::V1::TimeseriesWidgetDefinition.new({title:"Example Cloud Cost Query",title_size:"16",title_align:DatadogAPIClient::V1::WidgetTextAlign::LEFT,type:DatadogAPIClient::V1::TimeseriesWidgetDefinitionType::TIMESERIES,requests:[DatadogAPIClient::V1::TimeseriesWidgetRequest.new({formulas:[DatadogAPIClient::V1::WidgetFormula.new({formula:"query1",}),],queries:[DatadogAPIClient::V1::FormulaAndFunctionCloudCostQueryDefinition.new({data_source:DatadogAPIClient::V1::FormulaAndFunctionCloudCostDataSource::CLOUD_COST,name:"query1",query:"sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)",}),],response_format:DatadogAPIClient::V1::FormulaAndFunctionResponseFormat::TIMESERIES,style:DatadogAPIClient::V1::WidgetRequestStyle.new({palette:"dog_classic",line_type:DatadogAPIClient::V1::WidgetLineType::SOLID,line_width:DatadogAPIClient::V1::WidgetLineWidth::NORMAL,}),display_type:DatadogAPIClient::V1::WidgetDisplayType::BARS,}),],time:DatadogAPIClient::V1::WidgetLegacyLiveSpan.new({}),}),}),],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 queryrequire"datadog_api_client"api_instance=DatadogAPIClient::V1::DashboardsAPI.newbody=DatadogAPIClient::V1::Dashboard.new({title:"Example-Dashboard",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-Dashboard",description:"Example-Dashboard",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)
// Clients deserialize a dashboard with a empty time object
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_dashboards::DashboardsAPI;usedatadog_api_client::datadogV1::model::Dashboard;usedatadog_api_client::datadogV1::model::DashboardLayoutType;usedatadog_api_client::datadogV1::model::FormulaAndFunctionCloudCostDataSource;usedatadog_api_client::datadogV1::model::FormulaAndFunctionCloudCostQueryDefinition;usedatadog_api_client::datadogV1::model::FormulaAndFunctionQueryDefinition;usedatadog_api_client::datadogV1::model::FormulaAndFunctionResponseFormat;usedatadog_api_client::datadogV1::model::TimeseriesWidgetDefinition;usedatadog_api_client::datadogV1::model::TimeseriesWidgetDefinitionType;usedatadog_api_client::datadogV1::model::TimeseriesWidgetRequest;usedatadog_api_client::datadogV1::model::Widget;usedatadog_api_client::datadogV1::model::WidgetDefinition;usedatadog_api_client::datadogV1::model::WidgetDisplayType;usedatadog_api_client::datadogV1::model::WidgetFormula;usedatadog_api_client::datadogV1::model::WidgetLegacyLiveSpan;usedatadog_api_client::datadogV1::model::WidgetLineType;usedatadog_api_client::datadogV1::model::WidgetLineWidth;usedatadog_api_client::datadogV1::model::WidgetRequestStyle;usedatadog_api_client::datadogV1::model::WidgetTextAlign;usedatadog_api_client::datadogV1::model::WidgetTime;#[tokio::main]asyncfnmain(){letbody=Dashboard::new(DashboardLayoutType::ORDERED,"Example-Dashboard".to_string(),vec![Widget::new(WidgetDefinition::TimeseriesWidgetDefinition(Box::new(TimeseriesWidgetDefinition::new(vec![TimeseriesWidgetRequest::new().display_type(WidgetDisplayType::BARS).formulas(vec![WidgetFormula::new("query1".to_string())]).queries(vec![FormulaAndFunctionQueryDefinition::FormulaAndFunctionCloudCostQueryDefinition(Box::new(FormulaAndFunctionCloudCostQueryDefinition::new(FormulaAndFunctionCloudCostDataSource::CLOUD_COST,"query1".to_string(),"sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)".to_string(),),),)],).response_format(FormulaAndFunctionResponseFormat::TIMESERIES).style(WidgetRequestStyle::new().line_type(WidgetLineType::SOLID).line_width(WidgetLineWidth::NORMAL).palette("dog_classic".to_string()),)],TimeseriesWidgetDefinitionType::TIMESERIES,).time(WidgetTime::WidgetLegacyLiveSpan(Box::new(WidgetLegacyLiveSpan::new()))).title("Example Cloud Cost Query".to_string()).title_align(WidgetTextAlign::LEFT).title_size("16".to_string()),),),)],);letconfiguration=datadog::Configuration::new();letapi=DashboardsAPI::with_config(configuration);letresp=api.create_dashboard(body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
// Create a distribution widget using a histogram request containing a formulas
// and functions APM Stats query
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_dashboards::DashboardsAPI;usedatadog_api_client::datadogV1::model::Dashboard;usedatadog_api_client::datadogV1::model::DashboardLayoutType;usedatadog_api_client::datadogV1::model::DistributionWidgetDefinition;usedatadog_api_client::datadogV1::model::DistributionWidgetDefinitionType;usedatadog_api_client::datadogV1::model::DistributionWidgetHistogramRequestQuery;usedatadog_api_client::datadogV1::model::DistributionWidgetHistogramRequestType;usedatadog_api_client::datadogV1::model::DistributionWidgetRequest;usedatadog_api_client::datadogV1::model::DistributionWidgetXAxis;usedatadog_api_client::datadogV1::model::DistributionWidgetYAxis;usedatadog_api_client::datadogV1::model::FormulaAndFunctionApmResourceStatName;usedatadog_api_client::datadogV1::model::FormulaAndFunctionApmResourceStatsDataSource;usedatadog_api_client::datadogV1::model::FormulaAndFunctionApmResourceStatsQueryDefinition;usedatadog_api_client::datadogV1::model::Widget;usedatadog_api_client::datadogV1::model::WidgetDefinition;usedatadog_api_client::datadogV1::model::WidgetLayout;usedatadog_api_client::datadogV1::model::WidgetStyle;usedatadog_api_client::datadogV1::model::WidgetTextAlign;#[tokio::main]asyncfnmain(){letbody=Dashboard::new(DashboardLayoutType::ORDERED,"Example-Dashboard".to_string(),vec![Widget::new(WidgetDefinition::DistributionWidgetDefinition(Box::new(DistributionWidgetDefinition::new(vec![DistributionWidgetRequest::new().query(DistributionWidgetHistogramRequestQuery::FormulaAndFunctionApmResourceStatsQueryDefinition(Box::new(FormulaAndFunctionApmResourceStatsQueryDefinition::new(FormulaAndFunctionApmResourceStatsDataSource::APM_RESOURCE_STATS,"staging".to_string(),"query1".to_string(),"azure-bill-import".to_string(),FormulaAndFunctionApmResourceStatName::LATENCY_DISTRIBUTION,).group_by(vec!["resource_name".to_string()]).operation_name("universal.http.client".to_string()).primary_tag_name("datacenter".to_string()).primary_tag_value("*".to_string()),),),).request_type(DistributionWidgetHistogramRequestType::HISTOGRAM).style(WidgetStyle::new().palette("dog_classic".to_string()))],DistributionWidgetDefinitionType::DISTRIBUTION,).show_legend(false).title("APM Stats - Request latency HOP".to_string()).title_align(WidgetTextAlign::LEFT).title_size("16".to_string()).xaxis(DistributionWidgetXAxis::new().include_zero(true).max("auto".to_string()).min("auto".to_string()).scale("linear".to_string()),).yaxis(DistributionWidgetYAxis::new().include_zero(true).max("auto".to_string()).min("auto".to_string()).scale("linear".to_string()),),),),).layout(WidgetLayout::new(2,4,8,0))],).description(Some("".to_string()));letconfiguration=datadog::Configuration::new();letapi=DashboardsAPI::with_config(configuration);letresp=api.create_dashboard(body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
// Create a distribution widget using a histogram request containing a formulas
// and functions events query
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_dashboards::DashboardsAPI;usedatadog_api_client::datadogV1::model::Dashboard;usedatadog_api_client::datadogV1::model::DashboardLayoutType;usedatadog_api_client::datadogV1::model::DistributionWidgetDefinition;usedatadog_api_client::datadogV1::model::DistributionWidgetDefinitionType;usedatadog_api_client::datadogV1::model::DistributionWidgetHistogramRequestQuery;usedatadog_api_client::datadogV1::model::DistributionWidgetHistogramRequestType;usedatadog_api_client::datadogV1::model::DistributionWidgetRequest;usedatadog_api_client::datadogV1::model::DistributionWidgetXAxis;usedatadog_api_client::datadogV1::model::DistributionWidgetYAxis;usedatadog_api_client::datadogV1::model::FormulaAndFunctionEventAggregation;usedatadog_api_client::datadogV1::model::FormulaAndFunctionEventQueryDefinition;usedatadog_api_client::datadogV1::model::FormulaAndFunctionEventQueryDefinitionCompute;usedatadog_api_client::datadogV1::model::FormulaAndFunctionEventQueryDefinitionSearch;usedatadog_api_client::datadogV1::model::FormulaAndFunctionEventsDataSource;usedatadog_api_client::datadogV1::model::Widget;usedatadog_api_client::datadogV1::model::WidgetDefinition;usedatadog_api_client::datadogV1::model::WidgetLayout;usedatadog_api_client::datadogV1::model::WidgetTextAlign;#[tokio::main]asyncfnmain(){letbody=Dashboard::new(DashboardLayoutType::ORDERED,"Example-Dashboard".to_string(),vec![Widget::new(WidgetDefinition::DistributionWidgetDefinition(Box::new(DistributionWidgetDefinition::new(vec![DistributionWidgetRequest::new().query(DistributionWidgetHistogramRequestQuery::FormulaAndFunctionEventQueryDefinition(Box::new(FormulaAndFunctionEventQueryDefinition::new(FormulaAndFunctionEventQueryDefinitionCompute::new(FormulaAndFunctionEventAggregation::MIN,).metric("@duration".to_string()),FormulaAndFunctionEventsDataSource::EVENTS,"query1".to_string(),).group_by(vec![]).indexes(vec!["*".to_string()]).search(FormulaAndFunctionEventQueryDefinitionSearch::new("".to_string(),),),),),).request_type(DistributionWidgetHistogramRequestType::HISTOGRAM)],DistributionWidgetDefinitionType::DISTRIBUTION,).show_legend(false).title("Events Platform - Request latency HOP".to_string()).title_align(WidgetTextAlign::LEFT).title_size("16".to_string()).xaxis(DistributionWidgetXAxis::new().include_zero(true).max("auto".to_string()).min("auto".to_string()).scale("linear".to_string()),).yaxis(DistributionWidgetYAxis::new().include_zero(true).max("auto".to_string()).min("auto".to_string()).scale("linear".to_string()),),),),).layout(WidgetLayout::new(2,4,0,0))],).description(Some("Example-Dashboard".to_string()));letconfiguration=datadog::Configuration::new();letapi=DashboardsAPI::with_config(configuration);letresp=api.create_dashboard(body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Clients deserialize a dashboard with a empty time object
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.DashboardsApi(configuration);constparams: v1.DashboardsApiCreateDashboardRequest={body:{title:"Example-Dashboard",widgets:[{definition:{title:"Example Cloud Cost Query",titleSize:"16",titleAlign:"left",type:"timeseries",requests:[{formulas:[{formula:"query1",},],queries:[{dataSource:"cloud_cost",name:"query1",query:"sum:aws.cost.amortized{*} by {aws_product}.rollup(sum, monthly)",},],responseFormat:"timeseries",style:{palette:"dog_classic",lineType:"solid",lineWidth:"normal",},displayType:"bars",},],time:{},},},],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 APM Stats query
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.DashboardsApi(configuration);constparams: v1.DashboardsApiCreateDashboardRequest={body:{title:"Example-Dashboard",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-Dashboard",description:"Example-Dashboard",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));
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
Champ
Type
Description
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.
This property is deprecated; please use the Restriction Policies API instead to manage write authorization for individual dashboards.
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.
tags
[string]
List of team names representing ownership of a 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
DEPRECATED: (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with values.
values
[string]
One or many template variable values within the saved view, which will be unioned together using OR if more than one is specified. Cannot be used in conjunction with value.
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
DEPRECATED: (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with defaults.
defaults
[string]
One or many default values for template variables on load. If more than one default is specified, they will be unioned together with OR. Cannot be used in conjunction with default.
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.
type
string
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
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.
"""
Get 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.get_dashboard(dashboard_id=DASHBOARD_ID,)print(response)
# Get 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.get_dashboard(DASHBOARD_ID)
// Get a dashboard returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "dashboard" in the system
DashboardID:=os.Getenv("DASHBOARD_ID")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewDashboardsApi(apiClient)resp,r,err:=api.GetDashboard(ctx,DashboardID)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DashboardsApi.GetDashboard`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `DashboardsApi.GetDashboard`:\n%s\n",responseContent)}
// Get a dashboard returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.DashboardsApi;importcom.datadog.api.client.v1.model.Dashboard;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DashboardsApiapiInstance=newDashboardsApi(defaultClient);// there is a valid "dashboard" in the systemStringDASHBOARD_ID=System.getenv("DASHBOARD_ID");try{Dashboardresult=apiInstance.getDashboard(DASHBOARD_ID);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling DashboardsApi#getDashboard");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get a dashboard returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_dashboards::DashboardsAPI;#[tokio::main]asyncfnmain(){// there is a valid "dashboard" in the system
letdashboard_id=std::env::var("DASHBOARD_ID").unwrap();letconfiguration=datadog::Configuration::new();letapi=DashboardsAPI::with_config(configuration);letresp=api.get_dashboard(dashboard_id.clone()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get 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.DashboardsApiGetDashboardRequest={dashboardId: DASHBOARD_ID,};apiInstance.getDashboard(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
"""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 all dashboards returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::DashboardsAPI.newopts={filter_shared:false,}papi_instance.list_dashboards(opts)
// Get all dashboards returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewDashboardsApi(apiClient)resp,r,err:=api.ListDashboards(ctx,*datadogV1.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 all dashboards returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.DashboardsApi;importcom.datadog.api.client.v1.api.DashboardsApi.ListDashboardsOptionalParameters;importcom.datadog.api.client.v1.model.DashboardSummary;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DashboardsApiapiInstance=newDashboardsApi(defaultClient);try{DashboardSummaryresult=apiInstance.listDashboards(newListDashboardsOptionalParameters().filterShared(false));System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling DashboardsApi#listDashboards");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get all dashboards returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_dashboards::DashboardsAPI;usedatadog_api_client::datadogV1::api_dashboards::ListDashboardsOptionalParams;#[tokio::main]asyncfnmain(){letconfiguration=datadog::Configuration::new();letapi=DashboardsAPI::with_config(configuration);letresp=api.list_dashboards(ListDashboardsOptionalParams::default().filter_shared(false)).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* 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));
DEPRECATED: Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
This property is deprecated; please use the Restriction Policies API instead to manage write authorization for individual dashboards.
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.
tags
[string]
List of team names representing ownership of a 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
DEPRECATED: (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with values.
values
[string]
One or many template variable values within the saved view, which will be unioned together using OR if more than one is specified. Cannot be used in conjunction with value.
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
DEPRECATED: (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with defaults.
defaults
[string]
One or many default values for template variables on load. If more than one default is specified, they will be unioned together with OR. Cannot be used in conjunction with default.
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.
type
string
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
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.
{"layout_type":"ordered","title":"Example-Dashboard with list_stream widget","description":"Updated description","widgets":[{"definition":{"type":"list_stream","requests":[{"columns":[{"width":"auto","field":"timestamp"}],"query":{"data_source":"apm_issue_stream","query_string":""},"response_format":"event_list"}]}}]}
{"layout_type":"ordered","title":"Example-Dashboard with list_stream widget","description":"Updated description","tags":["team:foo","team:bar"],"widgets":[{"definition":{"type":"list_stream","requests":[{"columns":[{"width":"auto","field":"timestamp"}],"query":{"data_source":"apm_issue_stream","query_string":""},"response_format":"event_list"}]}}]}
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
Champ
Type
Description
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.
This property is deprecated; please use the Restriction Policies API instead to manage write authorization for individual dashboards.
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.
tags
[string]
List of team names representing ownership of a 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
DEPRECATED: (deprecated) The value of the template variable within the saved view. Cannot be used in conjunction with values.
values
[string]
One or many template variable values within the saved view, which will be unioned together using OR if more than one is specified. Cannot be used in conjunction with value.
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
DEPRECATED: (deprecated) The default value for the template variable on dashboard load. Cannot be used in conjunction with defaults.
defaults
[string]
One or many default values for template variables on load. If more than one default is specified, they will be unioned together with OR. Cannot be used in conjunction with default.
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.
type
string
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
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.
// Update a dashboard returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "dashboard" in the system
DashboardID:=os.Getenv("DASHBOARD_ID")body:=datadogV1.Dashboard{LayoutType:datadogV1.DASHBOARDLAYOUTTYPE_ORDERED,Title:"Example-Dashboard with list_stream widget",Description:*datadog.NewNullableString(datadog.PtrString("Updated description")),Widgets:[]datadogV1.Widget{{Definition:datadogV1.WidgetDefinition{ListStreamWidgetDefinition:&datadogV1.ListStreamWidgetDefinition{Type:datadogV1.LISTSTREAMWIDGETDEFINITIONTYPE_LIST_STREAM,Requests:[]datadogV1.ListStreamWidgetRequest{{Columns:[]datadogV1.ListStreamColumn{{Width:datadogV1.LISTSTREAMCOLUMNWIDTH_AUTO,Field:"timestamp",},},Query:datadogV1.ListStreamQuery{DataSource:datadogV1.LISTSTREAMSOURCE_APM_ISSUE_STREAM,QueryString:"",},ResponseFormat:datadogV1.LISTSTREAMRESPONSEFORMAT_EVENT_LIST,},},}},},},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewDashboardsApi(apiClient)resp,r,err:=api.UpdateDashboard(ctx,DashboardID,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DashboardsApi.UpdateDashboard`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `DashboardsApi.UpdateDashboard`:\n%s\n",responseContent)}
// Update a dashboard with tags returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "dashboard" in the system
DashboardID:=os.Getenv("DASHBOARD_ID")body:=datadogV1.Dashboard{LayoutType:datadogV1.DASHBOARDLAYOUTTYPE_ORDERED,Title:"Example-Dashboard with list_stream widget",Description:*datadog.NewNullableString(datadog.PtrString("Updated description")),Tags:*datadog.NewNullableList(&[]string{"team:foo","team:bar",}),Widgets:[]datadogV1.Widget{{Definition:datadogV1.WidgetDefinition{ListStreamWidgetDefinition:&datadogV1.ListStreamWidgetDefinition{Type:datadogV1.LISTSTREAMWIDGETDEFINITIONTYPE_LIST_STREAM,Requests:[]datadogV1.ListStreamWidgetRequest{{Columns:[]datadogV1.ListStreamColumn{{Width:datadogV1.LISTSTREAMCOLUMNWIDTH_AUTO,Field:"timestamp",},},Query:datadogV1.ListStreamQuery{DataSource:datadogV1.LISTSTREAMSOURCE_APM_ISSUE_STREAM,QueryString:"",},ResponseFormat:datadogV1.LISTSTREAMRESPONSEFORMAT_EVENT_LIST,},},}},},},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewDashboardsApi(apiClient)resp,r,err:=api.UpdateDashboard(ctx,DashboardID,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DashboardsApi.UpdateDashboard`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `DashboardsApi.UpdateDashboard`:\n%s\n",responseContent)}
// Update a dashboard returns "OK" responseimportcom.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.ListStreamColumn;importcom.datadog.api.client.v1.model.ListStreamColumnWidth;importcom.datadog.api.client.v1.model.ListStreamQuery;importcom.datadog.api.client.v1.model.ListStreamResponseFormat;importcom.datadog.api.client.v1.model.ListStreamSource;importcom.datadog.api.client.v1.model.ListStreamWidgetDefinition;importcom.datadog.api.client.v1.model.ListStreamWidgetDefinitionType;importcom.datadog.api.client.v1.model.ListStreamWidgetRequest;importcom.datadog.api.client.v1.model.Widget;importcom.datadog.api.client.v1.model.WidgetDefinition;importjava.util.Collections;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DashboardsApiapiInstance=newDashboardsApi(defaultClient);// there is a valid "dashboard" in the systemStringDASHBOARD_ID=System.getenv("DASHBOARD_ID");Dashboardbody=newDashboard().layoutType(DashboardLayoutType.ORDERED).title("Example-Dashboard with list_stream widget").description("Updated description").widgets(Collections.singletonList(newWidget().definition(newWidgetDefinition(newListStreamWidgetDefinition().type(ListStreamWidgetDefinitionType.LIST_STREAM).requests(Collections.singletonList(newListStreamWidgetRequest().columns(Collections.singletonList(newListStreamColumn().width(ListStreamColumnWidth.AUTO).field("timestamp"))).query(newListStreamQuery().dataSource(ListStreamSource.APM_ISSUE_STREAM).queryString("")).responseFormat(ListStreamResponseFormat.EVENT_LIST)))))));try{Dashboardresult=apiInstance.updateDashboard(DASHBOARD_ID,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling DashboardsApi#updateDashboard");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Update a dashboard with tags returns "OK" responseimportcom.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.ListStreamColumn;importcom.datadog.api.client.v1.model.ListStreamColumnWidth;importcom.datadog.api.client.v1.model.ListStreamQuery;importcom.datadog.api.client.v1.model.ListStreamResponseFormat;importcom.datadog.api.client.v1.model.ListStreamSource;importcom.datadog.api.client.v1.model.ListStreamWidgetDefinition;importcom.datadog.api.client.v1.model.ListStreamWidgetDefinitionType;importcom.datadog.api.client.v1.model.ListStreamWidgetRequest;importcom.datadog.api.client.v1.model.Widget;importcom.datadog.api.client.v1.model.WidgetDefinition;importjava.util.Arrays;importjava.util.Collections;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DashboardsApiapiInstance=newDashboardsApi(defaultClient);// there is a valid "dashboard" in the systemStringDASHBOARD_ID=System.getenv("DASHBOARD_ID");Dashboardbody=newDashboard().layoutType(DashboardLayoutType.ORDERED).title("Example-Dashboard with list_stream widget").description("Updated description").tags(Arrays.asList("team:foo","team:bar")).widgets(Collections.singletonList(newWidget().definition(newWidgetDefinition(newListStreamWidgetDefinition().type(ListStreamWidgetDefinitionType.LIST_STREAM).requests(Collections.singletonList(newListStreamWidgetRequest().columns(Collections.singletonList(newListStreamColumn().width(ListStreamColumnWidth.AUTO).field("timestamp"))).query(newListStreamQuery().dataSource(ListStreamSource.APM_ISSUE_STREAM).queryString("")).responseFormat(ListStreamResponseFormat.EVENT_LIST)))))));try{Dashboardresult=apiInstance.updateDashboard(DASHBOARD_ID,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling DashboardsApi#updateDashboard");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Update a dashboard returns "OK" response
"""fromosimportenvironfromdatadog_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.list_stream_columnimportListStreamColumnfromdatadog_api_client.v1.model.list_stream_column_widthimportListStreamColumnWidthfromdatadog_api_client.v1.model.list_stream_queryimportListStreamQueryfromdatadog_api_client.v1.model.list_stream_response_formatimportListStreamResponseFormatfromdatadog_api_client.v1.model.list_stream_sourceimportListStreamSourcefromdatadog_api_client.v1.model.list_stream_widget_definitionimportListStreamWidgetDefinitionfromdatadog_api_client.v1.model.list_stream_widget_definition_typeimportListStreamWidgetDefinitionTypefromdatadog_api_client.v1.model.list_stream_widget_requestimportListStreamWidgetRequestfromdatadog_api_client.v1.model.widgetimportWidget# there is a valid "dashboard" in the systemDASHBOARD_ID=environ["DASHBOARD_ID"]body=Dashboard(layout_type=DashboardLayoutType.ORDERED,title="Example-Dashboard with list_stream widget",description="Updated description",widgets=[Widget(definition=ListStreamWidgetDefinition(type=ListStreamWidgetDefinitionType.LIST_STREAM,requests=[ListStreamWidgetRequest(columns=[ListStreamColumn(width=ListStreamColumnWidth.AUTO,field="timestamp",),],query=ListStreamQuery(data_source=ListStreamSource.APM_ISSUE_STREAM,query_string="",),response_format=ListStreamResponseFormat.EVENT_LIST,),],),),],)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=DashboardsApi(api_client)response=api_instance.update_dashboard(dashboard_id=DASHBOARD_ID,body=body)print(response)
"""
Update a dashboard with tags returns "OK" response
"""fromosimportenvironfromdatadog_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.list_stream_columnimportListStreamColumnfromdatadog_api_client.v1.model.list_stream_column_widthimportListStreamColumnWidthfromdatadog_api_client.v1.model.list_stream_queryimportListStreamQueryfromdatadog_api_client.v1.model.list_stream_response_formatimportListStreamResponseFormatfromdatadog_api_client.v1.model.list_stream_sourceimportListStreamSourcefromdatadog_api_client.v1.model.list_stream_widget_definitionimportListStreamWidgetDefinitionfromdatadog_api_client.v1.model.list_stream_widget_definition_typeimportListStreamWidgetDefinitionTypefromdatadog_api_client.v1.model.list_stream_widget_requestimportListStreamWidgetRequestfromdatadog_api_client.v1.model.widgetimportWidget# there is a valid "dashboard" in the systemDASHBOARD_ID=environ["DASHBOARD_ID"]body=Dashboard(layout_type=DashboardLayoutType.ORDERED,title="Example-Dashboard with list_stream widget",description="Updated description",tags=["team:foo","team:bar",],widgets=[Widget(definition=ListStreamWidgetDefinition(type=ListStreamWidgetDefinitionType.LIST_STREAM,requests=[ListStreamWidgetRequest(columns=[ListStreamColumn(width=ListStreamColumnWidth.AUTO,field="timestamp",),],query=ListStreamQuery(data_source=ListStreamSource.APM_ISSUE_STREAM,query_string="",),response_format=ListStreamResponseFormat.EVENT_LIST,),],),),],)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=DashboardsApi(api_client)response=api_instance.update_dashboard(dashboard_id=DASHBOARD_ID,body=body)print(response)
# Update 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"]body=DatadogAPIClient::V1::Dashboard.new({layout_type:DatadogAPIClient::V1::DashboardLayoutType::ORDERED,title:"Example-Dashboard with list_stream widget",description:"Updated description",widgets:[DatadogAPIClient::V1::Widget.new({definition:DatadogAPIClient::V1::ListStreamWidgetDefinition.new({type:DatadogAPIClient::V1::ListStreamWidgetDefinitionType::LIST_STREAM,requests:[DatadogAPIClient::V1::ListStreamWidgetRequest.new({columns:[DatadogAPIClient::V1::ListStreamColumn.new({width:DatadogAPIClient::V1::ListStreamColumnWidth::AUTO,field:"timestamp",}),],query:DatadogAPIClient::V1::ListStreamQuery.new({data_source:DatadogAPIClient::V1::ListStreamSource::APM_ISSUE_STREAM,query_string:"",}),response_format:DatadogAPIClient::V1::ListStreamResponseFormat::EVENT_LIST,}),],}),}),],})papi_instance.update_dashboard(DASHBOARD_ID,body)
# Update a dashboard with tags returns "OK" 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::Dashboard.new({layout_type:DatadogAPIClient::V1::DashboardLayoutType::ORDERED,title:"Example-Dashboard with list_stream widget",description:"Updated description",tags:["team:foo","team:bar",],widgets:[DatadogAPIClient::V1::Widget.new({definition:DatadogAPIClient::V1::ListStreamWidgetDefinition.new({type:DatadogAPIClient::V1::ListStreamWidgetDefinitionType::LIST_STREAM,requests:[DatadogAPIClient::V1::ListStreamWidgetRequest.new({columns:[DatadogAPIClient::V1::ListStreamColumn.new({width:DatadogAPIClient::V1::ListStreamColumnWidth::AUTO,field:"timestamp",}),],query:DatadogAPIClient::V1::ListStreamQuery.new({data_source:DatadogAPIClient::V1::ListStreamSource::APM_ISSUE_STREAM,query_string:"",}),response_format:DatadogAPIClient::V1::ListStreamResponseFormat::EVENT_LIST,}),],}),}),],})papi_instance.update_dashboard(DASHBOARD_ID,body)
// Update a dashboard returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_dashboards::DashboardsAPI;usedatadog_api_client::datadogV1::model::Dashboard;usedatadog_api_client::datadogV1::model::DashboardLayoutType;usedatadog_api_client::datadogV1::model::ListStreamColumn;usedatadog_api_client::datadogV1::model::ListStreamColumnWidth;usedatadog_api_client::datadogV1::model::ListStreamQuery;usedatadog_api_client::datadogV1::model::ListStreamResponseFormat;usedatadog_api_client::datadogV1::model::ListStreamSource;usedatadog_api_client::datadogV1::model::ListStreamWidgetDefinition;usedatadog_api_client::datadogV1::model::ListStreamWidgetDefinitionType;usedatadog_api_client::datadogV1::model::ListStreamWidgetRequest;usedatadog_api_client::datadogV1::model::Widget;usedatadog_api_client::datadogV1::model::WidgetDefinition;#[tokio::main]asyncfnmain(){// there is a valid "dashboard" in the system
letdashboard_id=std::env::var("DASHBOARD_ID").unwrap();letbody=Dashboard::new(DashboardLayoutType::ORDERED,"Example-Dashboard with list_stream widget".to_string(),vec![Widget::new(WidgetDefinition::ListStreamWidgetDefinition(Box::new(ListStreamWidgetDefinition::new(vec![ListStreamWidgetRequest::new(vec![ListStreamColumn::new("timestamp".to_string(),ListStreamColumnWidth::AUTO,)],ListStreamQuery::new(ListStreamSource::APM_ISSUE_STREAM,"".to_string()),ListStreamResponseFormat::EVENT_LIST,)],ListStreamWidgetDefinitionType::LIST_STREAM,)),))],).description(Some("Updated description".to_string()));letconfiguration=datadog::Configuration::new();letapi=DashboardsAPI::with_config(configuration);letresp=api.update_dashboard(dashboard_id.clone(),body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
// Update a dashboard with tags returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_dashboards::DashboardsAPI;usedatadog_api_client::datadogV1::model::Dashboard;usedatadog_api_client::datadogV1::model::DashboardLayoutType;usedatadog_api_client::datadogV1::model::ListStreamColumn;usedatadog_api_client::datadogV1::model::ListStreamColumnWidth;usedatadog_api_client::datadogV1::model::ListStreamQuery;usedatadog_api_client::datadogV1::model::ListStreamResponseFormat;usedatadog_api_client::datadogV1::model::ListStreamSource;usedatadog_api_client::datadogV1::model::ListStreamWidgetDefinition;usedatadog_api_client::datadogV1::model::ListStreamWidgetDefinitionType;usedatadog_api_client::datadogV1::model::ListStreamWidgetRequest;usedatadog_api_client::datadogV1::model::Widget;usedatadog_api_client::datadogV1::model::WidgetDefinition;#[tokio::main]asyncfnmain(){// there is a valid "dashboard" in the system
letdashboard_id=std::env::var("DASHBOARD_ID").unwrap();letbody=Dashboard::new(DashboardLayoutType::ORDERED,"Example-Dashboard with list_stream widget".to_string(),vec![Widget::new(WidgetDefinition::ListStreamWidgetDefinition(Box::new(ListStreamWidgetDefinition::new(vec![ListStreamWidgetRequest::new(vec![ListStreamColumn::new("timestamp".to_string(),ListStreamColumnWidth::AUTO,)],ListStreamQuery::new(ListStreamSource::APM_ISSUE_STREAM,"".to_string()),ListStreamResponseFormat::EVENT_LIST,)],ListStreamWidgetDefinitionType::LIST_STREAM,)),))],).description(Some("Updated description".to_string())).tags(Some(vec!["team:foo".to_string(),"team:bar".to_string()]));letconfiguration=datadog::Configuration::new();letapi=DashboardsAPI::with_config(configuration);letresp=api.update_dashboard(dashboard_id.clone(),body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Update 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.DashboardsApiUpdateDashboardRequest={body:{layoutType:"ordered",title:"Example-Dashboard with list_stream widget",description:"Updated description",widgets:[{definition:{type:"list_stream",requests:[{columns:[{width:"auto",field:"timestamp",},],query:{dataSource:"apm_issue_stream",queryString:"",},responseFormat:"event_list",},],},},],},dashboardId: DASHBOARD_ID,};apiInstance.updateDashboard(params).then((data: v1.Dashboard)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
/**
* Update a dashboard with tags 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.DashboardsApiUpdateDashboardRequest={body:{layoutType:"ordered",title:"Example-Dashboard with list_stream widget",description:"Updated description",tags:["team:foo","team:bar"],widgets:[{definition:{type:"list_stream",requests:[{columns:[{width:"auto",field:"timestamp",},],query:{dataSource:"apm_issue_stream",queryString:"",},responseFormat:"event_list",},],},},],},dashboardId: DASHBOARD_ID,};apiInstance.updateDashboard(params).then((data: v1.Dashboard)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
"""
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
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "dashboard" in the system
DashboardID:=os.Getenv("DASHBOARD_ID")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.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" responseimportcom.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 systemStringDASHBOARD_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
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_dashboards::DashboardsAPI;#[tokio::main]asyncfnmain(){// there is a valid "dashboard" in the system
letdashboard_id=std::env::var("DASHBOARD_ID").unwrap();letconfiguration=datadog::Configuration::new();letapi=DashboardsAPI::with_config(configuration);letresp=api.delete_dashboard(dashboard_id.clone()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* 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 using the specified IDs. If there are any failures, no dashboards will be deleted (partial success is not allowed).
This endpoint requires the dashboards_write permission.
OAuth apps require the dashboards_write authorization scope to access this endpoint.
// Delete dashboards returns "No Content" response
packagemainimport("context""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "dashboard" in the system
DashboardID:=os.Getenv("DASHBOARD_ID")body:=datadogV1.DashboardBulkDeleteRequest{Data:[]datadogV1.DashboardBulkActionData{{Id:DashboardID,Type:datadogV1.DASHBOARDRESOURCETYPE_DASHBOARD,},},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.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" responseimportcom.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 systemStringDASHBOARD_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
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_dashboards::DashboardsAPI;usedatadog_api_client::datadogV1::model::DashboardBulkActionData;usedatadog_api_client::datadogV1::model::DashboardBulkDeleteRequest;usedatadog_api_client::datadogV1::model::DashboardResourceType;#[tokio::main]asyncfnmain(){// there is a valid "dashboard" in the system
letdashboard_id=std::env::var("DASHBOARD_ID").unwrap();letbody=DashboardBulkDeleteRequest::new(vec![DashboardBulkActionData::new(dashboard_id.clone(),DashboardResourceType::DASHBOARD,)]);letconfiguration=datadog::Configuration::new();letapi=DashboardsAPI::with_config(configuration);letresp=api.delete_dashboards(body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* 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));
Restore dashboards using the specified IDs. If there are any failures, no dashboards will be restored (partial success is not allowed).
This endpoint requires the dashboards_write permission.
OAuth apps require the dashboards_write authorization scope to access this endpoint.
// Restore deleted dashboards returns "No Content" response
packagemainimport("context""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "dashboard" in the system
DashboardID:=os.Getenv("DASHBOARD_ID")body:=datadogV1.DashboardRestoreRequest{Data:[]datadogV1.DashboardBulkActionData{{Id:DashboardID,Type:datadogV1.DASHBOARDRESOURCETYPE_DASHBOARD,},},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewDashboardsApi(apiClient)r,err:=api.RestoreDashboards(ctx,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DashboardsApi.RestoreDashboards`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}}
// Restore deleted dashboards returns "No Content" responseimportcom.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.DashboardResourceType;importcom.datadog.api.client.v1.model.DashboardRestoreRequest;importjava.util.Collections;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DashboardsApiapiInstance=newDashboardsApi(defaultClient);// there is a valid "dashboard" in the systemStringDASHBOARD_ID=System.getenv("DASHBOARD_ID");DashboardRestoreRequestbody=newDashboardRestoreRequest().data(Collections.singletonList(newDashboardBulkActionData().id(DASHBOARD_ID).type(DashboardResourceType.DASHBOARD)));try{apiInstance.restoreDashboards(body);}catch(ApiExceptione){System.err.println("Exception when calling DashboardsApi#restoreDashboards");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Restore deleted 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_resource_typeimportDashboardResourceTypefromdatadog_api_client.v1.model.dashboard_restore_requestimportDashboardRestoreRequest# there is a valid "dashboard" in the systemDASHBOARD_ID=environ["DASHBOARD_ID"]body=DashboardRestoreRequest(data=DashboardBulkActionDataList([DashboardBulkActionData(id=DASHBOARD_ID,type=DashboardResourceType.DASHBOARD,),]),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=DashboardsApi(api_client)api_instance.restore_dashboards(body=body)
# Restore deleted 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::DashboardRestoreRequest.new({data:[DatadogAPIClient::V1::DashboardBulkActionData.new({id:DASHBOARD_ID,type:DatadogAPIClient::V1::DashboardResourceType::DASHBOARD,}),],})api_instance.restore_dashboards(body)
// Restore deleted dashboards returns "No Content" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_dashboards::DashboardsAPI;usedatadog_api_client::datadogV1::model::DashboardBulkActionData;usedatadog_api_client::datadogV1::model::DashboardResourceType;usedatadog_api_client::datadogV1::model::DashboardRestoreRequest;#[tokio::main]asyncfnmain(){// there is a valid "dashboard" in the system
letdashboard_id=std::env::var("DASHBOARD_ID").unwrap();letbody=DashboardRestoreRequest::new(vec![DashboardBulkActionData::new(dashboard_id.clone(),DashboardResourceType::DASHBOARD,)]);letconfiguration=datadog::Configuration::new();letapi=DashboardsAPI::with_config(configuration);letresp=api.restore_dashboards(body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Restore deleted 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.DashboardsApiRestoreDashboardsRequest={body:{data:[{id: DASHBOARD_ID,type:"dashboard",},],},};apiInstance.restoreDashboards(params).then((data: any)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Partagez un dashboard privé spécifique. Les utilisateurs qui disposent de l’URL générée peuvent accéder au dashboard.
This endpoint requires the dashboards_public_share permission.
OAuth apps require the dashboards_public_share authorization scope to access this endpoint.
Requête
Body Data (required)
Corps de requête pour la création d’un dashboard partagé.
// Create a shared dashboard returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "dashboard" in the system
DashboardID:=os.Getenv("DASHBOARD_ID")body:=datadogV1.SharedDashboard{DashboardId:DashboardID,DashboardType:datadogV1.DASHBOARDTYPE_CUSTOM_TIMEBOARD,ShareType:*datadogV1.NewNullableDashboardShareType(datadogV1.DASHBOARDSHARETYPE_OPEN.Ptr()),GlobalTime:&datadogV1.DashboardGlobalTime{LiveSpan:datadogV1.DASHBOARDGLOBALTIMELIVESPAN_PAST_ONE_HOUR.Ptr(),},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewDashboardsApi(apiClient)resp,r,err:=api.CreatePublicDashboard(ctx,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DashboardsApi.CreatePublicDashboard`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `DashboardsApi.CreatePublicDashboard`:\n%s\n",responseContent)}
// Create a shared dashboard returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.DashboardsApi;importcom.datadog.api.client.v1.model.DashboardGlobalTime;importcom.datadog.api.client.v1.model.DashboardGlobalTimeLiveSpan;importcom.datadog.api.client.v1.model.DashboardShareType;importcom.datadog.api.client.v1.model.DashboardType;importcom.datadog.api.client.v1.model.SharedDashboard;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DashboardsApiapiInstance=newDashboardsApi(defaultClient);// there is a valid "dashboard" in the systemStringDASHBOARD_ID=System.getenv("DASHBOARD_ID");SharedDashboardbody=newSharedDashboard().dashboardId(DASHBOARD_ID).dashboardType(DashboardType.CUSTOM_TIMEBOARD).shareType(DashboardShareType.OPEN).globalTime(newDashboardGlobalTime().liveSpan(DashboardGlobalTimeLiveSpan.PAST_ONE_HOUR));try{SharedDashboardresult=apiInstance.createPublicDashboard(body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling DashboardsApi#createPublicDashboard");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Create a shared dashboard returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.dashboards_apiimportDashboardsApifromdatadog_api_client.v1.model.dashboard_global_timeimportDashboardGlobalTimefromdatadog_api_client.v1.model.dashboard_global_time_live_spanimportDashboardGlobalTimeLiveSpanfromdatadog_api_client.v1.model.dashboard_share_typeimportDashboardShareTypefromdatadog_api_client.v1.model.dashboard_typeimportDashboardTypefromdatadog_api_client.v1.model.shared_dashboardimportSharedDashboard# there is a valid "dashboard" in the systemDASHBOARD_ID=environ["DASHBOARD_ID"]body=SharedDashboard(dashboard_id=DASHBOARD_ID,dashboard_type=DashboardType.CUSTOM_TIMEBOARD,share_type=DashboardShareType.OPEN,global_time=DashboardGlobalTime(live_span=DashboardGlobalTimeLiveSpan.PAST_ONE_HOUR,),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=DashboardsApi(api_client)response=api_instance.create_public_dashboard(body=body)print(response)
# Create a shared 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"]body=DatadogAPIClient::V1::SharedDashboard.new({dashboard_id:DASHBOARD_ID,dashboard_type:DatadogAPIClient::V1::DashboardType::CUSTOM_TIMEBOARD,share_type:DatadogAPIClient::V1::DashboardShareType::OPEN,global_time:DatadogAPIClient::V1::DashboardGlobalTime.new({live_span:DatadogAPIClient::V1::DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR,}),})papi_instance.create_public_dashboard(body)
// Create a shared dashboard returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_dashboards::DashboardsAPI;usedatadog_api_client::datadogV1::model::DashboardGlobalTime;usedatadog_api_client::datadogV1::model::DashboardGlobalTimeLiveSpan;usedatadog_api_client::datadogV1::model::DashboardShareType;usedatadog_api_client::datadogV1::model::DashboardType;usedatadog_api_client::datadogV1::model::SharedDashboard;#[tokio::main]asyncfnmain(){// there is a valid "dashboard" in the system
letdashboard_id=std::env::var("DASHBOARD_ID").unwrap();letbody=SharedDashboard::new(dashboard_id.clone(),DashboardType::CUSTOM_TIMEBOARD).global_time(DashboardGlobalTime::new().live_span(DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR),).share_type(Some(DashboardShareType::OPEN));letconfiguration=datadog::Configuration::new();letapi=DashboardsAPI::with_config(configuration);letresp=api.create_public_dashboard(body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Create a shared 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.DashboardsApiCreatePublicDashboardRequest={body:{dashboardId: DASHBOARD_ID,dashboardType:"custom_timeboard",shareType:"open",globalTime:{liveSpan:"1h",},},};apiInstance.createPublicDashboard(params).then((data: v1.SharedDashboard)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Récupérez les métadonnées de partage d’un dashboard partagé existant associées au token spécifié.
This endpoint requires the dashboards_read permission.
OAuth apps require the dashboards_read authorization scope to access this endpoint.
Arguments
Paramètres du chemin
Nom
Type
Description
token [required]
string
The token of the shared dashboard. Generated when a dashboard is shared.
"""
Get a shared dashboard returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.dashboards_apiimportDashboardsApi# there is a valid "shared_dashboard" in the systemSHARED_DASHBOARD_TOKEN=environ["SHARED_DASHBOARD_TOKEN"]configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=DashboardsApi(api_client)response=api_instance.get_public_dashboard(token=SHARED_DASHBOARD_TOKEN,)print(response)
# Get a shared dashboard returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::DashboardsAPI.new# there is a valid "shared_dashboard" in the systemSHARED_DASHBOARD_TOKEN=ENV["SHARED_DASHBOARD_TOKEN"]papi_instance.get_public_dashboard(SHARED_DASHBOARD_TOKEN)
// Get a shared dashboard returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "shared_dashboard" in the system
SharedDashboardToken:=os.Getenv("SHARED_DASHBOARD_TOKEN")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewDashboardsApi(apiClient)resp,r,err:=api.GetPublicDashboard(ctx,SharedDashboardToken)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DashboardsApi.GetPublicDashboard`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `DashboardsApi.GetPublicDashboard`:\n%s\n",responseContent)}
// Get a shared dashboard returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.DashboardsApi;importcom.datadog.api.client.v1.model.SharedDashboard;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DashboardsApiapiInstance=newDashboardsApi(defaultClient);// there is a valid "shared_dashboard" in the systemStringSHARED_DASHBOARD_TOKEN=System.getenv("SHARED_DASHBOARD_TOKEN");try{SharedDashboardresult=apiInstance.getPublicDashboard(SHARED_DASHBOARD_TOKEN);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling DashboardsApi#getPublicDashboard");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get a shared dashboard returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_dashboards::DashboardsAPI;#[tokio::main]asyncfnmain(){// there is a valid "shared_dashboard" in the system
letshared_dashboard_token=std::env::var("SHARED_DASHBOARD_TOKEN").unwrap();letconfiguration=datadog::Configuration::new();letapi=DashboardsAPI::with_config(configuration);letresp=api.get_public_dashboard(shared_dashboard_token.clone()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get a shared dashboard returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.DashboardsApi(configuration);// there is a valid "shared_dashboard" in the system
constSHARED_DASHBOARD_TOKEN=process.env.SHARED_DASHBOARD_TOKENasstring;constparams: v1.DashboardsApiGetPublicDashboardRequest={token: SHARED_DASHBOARD_TOKEN,};apiInstance.getPublicDashboard(params).then((data: v1.SharedDashboard)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
// Update a shared dashboard returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "shared_dashboard" in the system
SharedDashboardToken:=os.Getenv("SHARED_DASHBOARD_TOKEN")body:=datadogV1.SharedDashboardUpdateRequest{GlobalTime:*datadogV1.NewNullableSharedDashboardUpdateRequestGlobalTime(&datadogV1.SharedDashboardUpdateRequestGlobalTime{LiveSpan:datadogV1.DASHBOARDGLOBALTIMELIVESPAN_PAST_FIFTEEN_MINUTES.Ptr(),}),ShareList:*datadog.NewNullableList(&[]string{}),ShareType:*datadogV1.NewNullableDashboardShareType(datadogV1.DASHBOARDSHARETYPE_OPEN.Ptr()),}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewDashboardsApi(apiClient)resp,r,err:=api.UpdatePublicDashboard(ctx,SharedDashboardToken,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DashboardsApi.UpdatePublicDashboard`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `DashboardsApi.UpdatePublicDashboard`:\n%s\n",responseContent)}
// Update a shared dashboard returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.DashboardsApi;importcom.datadog.api.client.v1.model.DashboardGlobalTimeLiveSpan;importcom.datadog.api.client.v1.model.DashboardShareType;importcom.datadog.api.client.v1.model.SharedDashboard;importcom.datadog.api.client.v1.model.SharedDashboardUpdateRequest;importcom.datadog.api.client.v1.model.SharedDashboardUpdateRequestGlobalTime;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DashboardsApiapiInstance=newDashboardsApi(defaultClient);// there is a valid "shared_dashboard" in the systemStringSHARED_DASHBOARD_TOKEN=System.getenv("SHARED_DASHBOARD_TOKEN");SharedDashboardUpdateRequestbody=newSharedDashboardUpdateRequest().globalTime(newSharedDashboardUpdateRequestGlobalTime().liveSpan(DashboardGlobalTimeLiveSpan.PAST_FIFTEEN_MINUTES)).shareType(DashboardShareType.OPEN);try{SharedDashboardresult=apiInstance.updatePublicDashboard(SHARED_DASHBOARD_TOKEN,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling DashboardsApi#updatePublicDashboard");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Update a shared dashboard returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.dashboards_apiimportDashboardsApifromdatadog_api_client.v1.model.dashboard_global_time_live_spanimportDashboardGlobalTimeLiveSpanfromdatadog_api_client.v1.model.dashboard_share_typeimportDashboardShareTypefromdatadog_api_client.v1.model.shared_dashboard_update_requestimportSharedDashboardUpdateRequestfromdatadog_api_client.v1.model.shared_dashboard_update_request_global_timeimport(SharedDashboardUpdateRequestGlobalTime,)# there is a valid "shared_dashboard" in the systemSHARED_DASHBOARD_TOKEN=environ["SHARED_DASHBOARD_TOKEN"]body=SharedDashboardUpdateRequest(global_time=SharedDashboardUpdateRequestGlobalTime(live_span=DashboardGlobalTimeLiveSpan.PAST_FIFTEEN_MINUTES,),share_list=[],share_type=DashboardShareType.OPEN,)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=DashboardsApi(api_client)response=api_instance.update_public_dashboard(token=SHARED_DASHBOARD_TOKEN,body=body)print(response)
# Update a shared dashboard returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::DashboardsAPI.new# there is a valid "shared_dashboard" in the systemSHARED_DASHBOARD_TOKEN=ENV["SHARED_DASHBOARD_TOKEN"]body=DatadogAPIClient::V1::SharedDashboardUpdateRequest.new({global_time:DatadogAPIClient::V1::SharedDashboardUpdateRequestGlobalTime.new({live_span:DatadogAPIClient::V1::DashboardGlobalTimeLiveSpan::PAST_FIFTEEN_MINUTES,}),share_list:[],share_type:DatadogAPIClient::V1::DashboardShareType::OPEN,})papi_instance.update_public_dashboard(SHARED_DASHBOARD_TOKEN,body)
// Update a shared dashboard returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_dashboards::DashboardsAPI;usedatadog_api_client::datadogV1::model::DashboardGlobalTimeLiveSpan;usedatadog_api_client::datadogV1::model::DashboardShareType;usedatadog_api_client::datadogV1::model::SharedDashboardUpdateRequest;usedatadog_api_client::datadogV1::model::SharedDashboardUpdateRequestGlobalTime;#[tokio::main]asyncfnmain(){// there is a valid "shared_dashboard" in the system
letshared_dashboard_token=std::env::var("SHARED_DASHBOARD_TOKEN").unwrap();letbody=SharedDashboardUpdateRequest::new().global_time(Some(SharedDashboardUpdateRequestGlobalTime::new().live_span(DashboardGlobalTimeLiveSpan::PAST_FIFTEEN_MINUTES),)).share_list(Some(vec![])).share_type(Some(DashboardShareType::OPEN));letconfiguration=datadog::Configuration::new();letapi=DashboardsAPI::with_config(configuration);letresp=api.update_public_dashboard(shared_dashboard_token.clone(),body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Update a shared dashboard returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.DashboardsApi(configuration);// there is a valid "shared_dashboard" in the system
constSHARED_DASHBOARD_TOKEN=process.env.SHARED_DASHBOARD_TOKENasstring;constparams: v1.DashboardsApiUpdatePublicDashboardRequest={body:{globalTime:{liveSpan:"15m",},shareList:[],shareType:"open",},token: SHARED_DASHBOARD_TOKEN,};apiInstance.updatePublicDashboard(params).then((data: v1.SharedDashboard)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Envoyez à des adresses spécifiques des e-mails contenant des liens d’accès à un dashboard partagé authentifié spécifique. Les adresses e-mail doivent déjà appartenir à la liste de partage du dashboard partagé authentifié.
This endpoint requires the dashboards_public_share permission.
OAuth apps require the dashboards_public_share authorization scope to access this endpoint.
Arguments
Paramètres du chemin
Nom
Type
Description
token [required]
string
The token of the shared dashboard.
Requête
Body Data (required)
Corps de requête pour l’invitation à consulter un dashboard partagé.
// Send shared dashboard invitation email returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "shared_dashboard" in the system
SharedDashboardToken:=os.Getenv("SHARED_DASHBOARD_TOKEN")body:=datadogV1.SharedDashboardInvites{Data:datadogV1.SharedDashboardInvitesData{SharedDashboardInvitesDataObject:&datadogV1.SharedDashboardInvitesDataObject{Attributes:datadogV1.SharedDashboardInvitesDataObjectAttributes{Email:datadog.PtrString("exampledashboard@datadoghq.com"),},Type:datadogV1.DASHBOARDINVITETYPE_PUBLIC_DASHBOARD_INVITATION,}},}ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewDashboardsApi(apiClient)resp,r,err:=api.SendPublicDashboardInvitation(ctx,SharedDashboardToken,body)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DashboardsApi.SendPublicDashboardInvitation`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `DashboardsApi.SendPublicDashboardInvitation`:\n%s\n",responseContent)}
// Send shared dashboard invitation email returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.DashboardsApi;importcom.datadog.api.client.v1.model.DashboardInviteType;importcom.datadog.api.client.v1.model.SharedDashboardInvites;importcom.datadog.api.client.v1.model.SharedDashboardInvitesData;importcom.datadog.api.client.v1.model.SharedDashboardInvitesDataObject;importcom.datadog.api.client.v1.model.SharedDashboardInvitesDataObjectAttributes;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DashboardsApiapiInstance=newDashboardsApi(defaultClient);// there is a valid "shared_dashboard" in the systemStringSHARED_DASHBOARD_TOKEN=System.getenv("SHARED_DASHBOARD_TOKEN");SharedDashboardInvitesbody=newSharedDashboardInvites().data(newSharedDashboardInvitesData(newSharedDashboardInvitesDataObject().attributes(newSharedDashboardInvitesDataObjectAttributes().email("exampledashboard@datadoghq.com")).type(DashboardInviteType.PUBLIC_DASHBOARD_INVITATION)));try{SharedDashboardInvitesresult=apiInstance.sendPublicDashboardInvitation(SHARED_DASHBOARD_TOKEN,body);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling DashboardsApi#sendPublicDashboardInvitation");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
"""
Send shared dashboard invitation email returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.dashboards_apiimportDashboardsApifromdatadog_api_client.v1.model.dashboard_invite_typeimportDashboardInviteTypefromdatadog_api_client.v1.model.shared_dashboard_invitesimportSharedDashboardInvitesfromdatadog_api_client.v1.model.shared_dashboard_invites_data_objectimportSharedDashboardInvitesDataObjectfromdatadog_api_client.v1.model.shared_dashboard_invites_data_object_attributesimport(SharedDashboardInvitesDataObjectAttributes,)# there is a valid "shared_dashboard" in the systemSHARED_DASHBOARD_TOKEN=environ["SHARED_DASHBOARD_TOKEN"]body=SharedDashboardInvites(data=SharedDashboardInvitesDataObject(attributes=SharedDashboardInvitesDataObjectAttributes(email="exampledashboard@datadoghq.com",),type=DashboardInviteType.PUBLIC_DASHBOARD_INVITATION,),)configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=DashboardsApi(api_client)response=api_instance.send_public_dashboard_invitation(token=SHARED_DASHBOARD_TOKEN,body=body)print(response)
# Send shared dashboard invitation email returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::DashboardsAPI.new# there is a valid "shared_dashboard" in the systemSHARED_DASHBOARD_TOKEN=ENV["SHARED_DASHBOARD_TOKEN"]body=DatadogAPIClient::V1::SharedDashboardInvites.new({data:DatadogAPIClient::V1::SharedDashboardInvitesDataObject.new({attributes:DatadogAPIClient::V1::SharedDashboardInvitesDataObjectAttributes.new({email:"exampledashboard@datadoghq.com",}),type:DatadogAPIClient::V1::DashboardInviteType::PUBLIC_DASHBOARD_INVITATION,}),})papi_instance.send_public_dashboard_invitation(SHARED_DASHBOARD_TOKEN,body)
// Send shared dashboard invitation email returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_dashboards::DashboardsAPI;usedatadog_api_client::datadogV1::model::DashboardInviteType;usedatadog_api_client::datadogV1::model::SharedDashboardInvites;usedatadog_api_client::datadogV1::model::SharedDashboardInvitesData;usedatadog_api_client::datadogV1::model::SharedDashboardInvitesDataObject;usedatadog_api_client::datadogV1::model::SharedDashboardInvitesDataObjectAttributes;#[tokio::main]asyncfnmain(){// there is a valid "shared_dashboard" in the system
letshared_dashboard_token=std::env::var("SHARED_DASHBOARD_TOKEN").unwrap();letbody=SharedDashboardInvites::new(SharedDashboardInvitesData::SharedDashboardInvitesDataObject(Box::new(SharedDashboardInvitesDataObject::new(SharedDashboardInvitesDataObjectAttributes::new().email("exampledashboard@datadoghq.com".to_string()),DashboardInviteType::PUBLIC_DASHBOARD_INVITATION,),)),);letconfiguration=datadog::Configuration::new();letapi=DashboardsAPI::with_config(configuration);letresp=api.send_public_dashboard_invitation(shared_dashboard_token.clone(),body).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Send shared dashboard invitation email returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.DashboardsApi(configuration);// there is a valid "shared_dashboard" in the system
constSHARED_DASHBOARD_TOKEN=process.env.SHARED_DASHBOARD_TOKENasstring;constparams: v1.DashboardsApiSendPublicDashboardInvitationRequest={body:{data:{attributes:{email:"exampledashboard@datadoghq.com",},type:"public_dashboard_invitation",},},token: SHARED_DASHBOARD_TOKEN,};apiInstance.sendPublicDashboardInvitation(params).then((data: v1.SharedDashboardInvites)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Décrivez les invitations qui existent pour un dashboard partagé donné (avec pagination).
This endpoint requires the dashboards_public_share permission.
OAuth apps require the dashboards_public_share authorization scope to access this endpoint.
Arguments
Paramètres du chemin
Nom
Type
Description
token [required]
string
Token of the shared dashboard for which to fetch invitations.
Chaînes de requête
Nom
Type
Description
page_size
integer
The number of records to return in a single request.
"""
Get all invitations for a shared dashboard returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v1.api.dashboards_apiimportDashboardsApi# there is a valid "shared_dashboard" in the systemSHARED_DASHBOARD_TOKEN=environ["SHARED_DASHBOARD_TOKEN"]configuration=Configuration()withApiClient(configuration)asapi_client:api_instance=DashboardsApi(api_client)response=api_instance.get_public_dashboard_invitations(token=SHARED_DASHBOARD_TOKEN,)print(response)
# Get all invitations for a shared dashboard returns "OK" responserequire"datadog_api_client"api_instance=DatadogAPIClient::V1::DashboardsAPI.new# there is a valid "shared_dashboard" in the systemSHARED_DASHBOARD_TOKEN=ENV["SHARED_DASHBOARD_TOKEN"]papi_instance.get_public_dashboard_invitations(SHARED_DASHBOARD_TOKEN)
// Get all invitations for a shared dashboard returns "OK" response
packagemainimport("context""encoding/json""fmt""os""github.com/DataDog/datadog-api-client-go/v2/api/datadog""github.com/DataDog/datadog-api-client-go/v2/api/datadogV1")funcmain(){// there is a valid "shared_dashboard" in the system
SharedDashboardToken:=os.Getenv("SHARED_DASHBOARD_TOKEN")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()apiClient:=datadog.NewAPIClient(configuration)api:=datadogV1.NewDashboardsApi(apiClient)resp,r,err:=api.GetPublicDashboardInvitations(ctx,SharedDashboardToken,*datadogV1.NewGetPublicDashboardInvitationsOptionalParameters())iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `DashboardsApi.GetPublicDashboardInvitations`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `DashboardsApi.GetPublicDashboardInvitations`:\n%s\n",responseContent)}
// Get all invitations for a shared dashboard returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v1.api.DashboardsApi;importcom.datadog.api.client.v1.model.SharedDashboardInvites;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();DashboardsApiapiInstance=newDashboardsApi(defaultClient);// there is a valid "shared_dashboard" in the systemStringSHARED_DASHBOARD_TOKEN=System.getenv("SHARED_DASHBOARD_TOKEN");try{SharedDashboardInvitesresult=apiInstance.getPublicDashboardInvitations(SHARED_DASHBOARD_TOKEN);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling DashboardsApi#getPublicDashboardInvitations");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get all invitations for a shared dashboard returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV1::api_dashboards::DashboardsAPI;usedatadog_api_client::datadogV1::api_dashboards::GetPublicDashboardInvitationsOptionalParams;#[tokio::main]asyncfnmain(){// there is a valid "shared_dashboard" in the system
letshared_dashboard_token=std::env::var("SHARED_DASHBOARD_TOKEN").unwrap();letconfiguration=datadog::Configuration::new();letapi=DashboardsAPI::with_config(configuration);letresp=api.get_public_dashboard_invitations(shared_dashboard_token.clone(),GetPublicDashboardInvitationsOptionalParams::default(),).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get all invitations for a shared dashboard returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.DashboardsApi(configuration);// there is a valid "shared_dashboard" in the system
constSHARED_DASHBOARD_TOKEN=process.env.SHARED_DASHBOARD_TOKENasstring;constparams: v1.DashboardsApiGetPublicDashboardInvitationsRequest={token: SHARED_DASHBOARD_TOKEN,};apiInstance.getPublicDashboardInvitations(params).then((data: v1.SharedDashboardInvites)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Révoquez l’URL publique pour le dashboard associé à un token spécifique. Ce dashboard devient alors privé.
This endpoint requires the dashboards_public_share permission.
OAuth apps require the dashboards_public_share authorization scope to access this endpoint.
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Revoke a shared dashboard URL returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.DashboardsApi(configuration);constparams: v1.DashboardsApiDeletePublicDashboardRequest={token:"token",};apiInstance.deletePublicDashboard(params).then((data: v1.DeleteSharedDashboardResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
Révoquez, pour des adresses e-mail précises, les e-mails d’invitation envoyés précédemment et les sessions actives utilisées afin d’accéder à un dashboard partagé donné.
This endpoint requires the dashboards_public_share permission.
OAuth apps require the dashboards_public_share authorization scope to access this endpoint.
Arguments
Paramètres du chemin
Nom
Type
Description
token [required]
string
The token of the shared dashboard.
Requête
Body Data (required)
Corps de requête pour la suppression d’une invitation à consulter un dashboard partagé.
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Revoke shared dashboard invitations returns "OK" response
*/import{client,v1}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();constapiInstance=newv1.DashboardsApi(configuration);constparams: v1.DashboardsApiDeletePublicDashboardInvitationRequest={body:{data:[{attributes:{email:"test@datadoghq.com",},type:"public_dashboard_invitation",},],},token:"token",};apiInstance.deletePublicDashboardInvitation(params).then((data: any)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));
