Language
Datadog Site
Interact with your dashboard lists through the API to make it easier to organize, find, and share all of your dashboards with your team and organization.
POST https://api.ap1.datadoghq.com/api/v1/dashboardhttps://api.datadoghq.eu/api/v1/dashboardhttps://api.ddog-gov.com/api/v1/dashboardhttps://api.datadoghq.com/api/v1/dashboardhttps://api.us3.datadoghq.com/api/v1/dashboardhttps://api.us5.datadoghq.com/api/v1/dashboard
Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the as_count() or as_rate() modifiers appended.
Refer to the following documentation for more information on these modifiers.
This endpoint requires the dashboards_write authorization scope.
Create a dashboard request body.
항목
유형
설명
author_handle
string
Identifier of the dashboard author.
author_name
string
Name of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
ID of the dashboard.
is_read_only
boolean
DEPRECATED: Whether this dashboard is read-only. If True, only the author and admins can make changes to it. Prefer using restricted_roles to manage write authorization.
layout_type [required]
enum
Layout type of the dashboard.
Allowed enum values: ordered,free
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
reflow_type
enum
Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'.
If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto',
widgets should not have layouts.
Allowed enum values: auto,fixed
restricted_roles
[string]
A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
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.
title [required]
string
Title of the dashboard.
url
string
The URL of the dashboard.
widgets [required]
[object]
List of widgets to display on the dashboard.
id
int64
ID of the widget.
layout
object
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",
"description": "",
"widgets": [
{
"definition": {
"title": "APM Stats - Request latency HOP",
"title_size": "16",
"title_align": "left",
"show_legend": false,
"type": "distribution",
"xaxis": {
"max": "auto",
"include_zero": true,
"scale": "linear",
"min": "auto"
},
"yaxis": {
"max": "auto",
"include_zero": true,
"scale": "linear",
"min": "auto"
},
"requests": [
{
"query": {
"primary_tag_value": "*",
"stat": "latency_distribution",
"data_source": "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": "histogram",
"style": {
"palette": "dog_classic"
}
}
]
},
"layout": {
"x": 8,
"y": 0,
"width": 4,
"height": 2
}
}
],
"layout_type": "ordered"
}{
"title": "Example-Dashboard",
"description": "Example-Dashboard",
"widgets": [
{
"definition": {
"title": "Events Platform - Request latency HOP",
"title_size": "16",
"title_align": "left",
"show_legend": false,
"type": "distribution",
"xaxis": {
"max": "auto",
"include_zero": true,
"scale": "linear",
"min": "auto"
},
"yaxis": {
"max": "auto",
"include_zero": true,
"scale": "linear",
"min": "auto"
},
"requests": [
{
"query": {
"search": {
"query": ""
},
"data_source": "events",
"compute": {
"metric": "@duration",
"aggregation": "min"
},
"name": "query1",
"indexes": [
"*"
],
"group_by": []
},
"request_type": "histogram"
}
]
},
"layout": {
"x": 0,
"y": 0,
"width": 4,
"height": 2
}
}
],
"layout_type": "ordered"
}{
"title": "Example-Dashboard",
"widgets": [
{
"definition": {
"title": "Metrics HOP",
"title_size": "16",
"title_align": "left",
"show_legend": false,
"type": "distribution",
"custom_links": [
{
"label": "Example",
"link": "https://example.org/"
}
],
"xaxis": {
"max": "auto",
"include_zero": true,
"scale": "linear",
"min": "auto"
},
"yaxis": {
"max": "auto",
"include_zero": true,
"scale": "linear",
"min": "auto"
},
"requests": [
{
"query": {
"query": "histogram:trace.Load{*}",
"data_source": "metrics",
"name": "query1"
},
"request_type": "histogram",
"style": {
"palette": "dog_classic"
}
}
]
},
"layout": {
"x": 0,
"y": 0,
"width": 4,
"height": 2
}
}
],
"layout_type": "ordered"
}OK
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.
항목
유형
설명
author_handle
string
Identifier of the dashboard author.
author_name
string
Name of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
ID of the dashboard.
is_read_only
boolean
DEPRECATED: Whether this dashboard is read-only. If True, only the author and admins can make changes to it. Prefer using restricted_roles to manage write authorization.
layout_type [required]
enum
Layout type of the dashboard.
Allowed enum values: ordered,free
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
reflow_type
enum
Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'.
If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto',
widgets should not have layouts.
Allowed enum values: auto,fixed
restricted_roles
[string]
A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
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.
title [required]
string
Title of the dashboard.
url
string
The URL of the dashboard.
widgets [required]
[object]
List of widgets to display on the dashboard.
id
int64
ID of the widget.
layout
object
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.
{
"author_handle": "test@datadoghq.com",
"author_name": "John Doe",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"id": "123-abc-456",
"is_read_only": false,
"layout_type": "ordered",
"modified_at": "2019-09-19T10:00:00.000Z",
"notify_list": [],
"reflow_type": "string",
"restricted_roles": [],
"tags": [],
"template_variable_presets": [
{
"name": "string",
"template_variables": [
{
"name": "string",
"value": "string",
"values": []
}
]
}
],
"template_variables": [
{
"available_values": [
"my-host",
"host1",
"host2"
],
"default": "my-host",
"defaults": [
"my-host-1",
"my-host-2"
],
"name": "host1",
"prefix": "host"
}
],
"title": "",
"url": "/dashboard/123-abc-456/example-dashboard-title",
"widgets": [
{
"definition": {
"requests": {
"fill": {
"q": "avg:system.cpu.user{*}"
}
},
"type": "hostmap"
},
"id": "integer",
"layout": {
"height": 0,
"is_column_break": false,
"width": 0,
"x": 0,
"y": 0
}
}
]
}Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}Authentication Error
Error response object.
{
"errors": [
"Bad Request"
]
}Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"title": "Example-Dashboard",
"description": "",
"widgets": [
{
"definition": {
"title": "APM Stats - Request latency HOP",
"title_size": "16",
"title_align": "left",
"show_legend": false,
"type": "distribution",
"xaxis": {
"max": "auto",
"include_zero": true,
"scale": "linear",
"min": "auto"
},
"yaxis": {
"max": "auto",
"include_zero": true,
"scale": "linear",
"min": "auto"
},
"requests": [
{
"query": {
"primary_tag_value": "*",
"stat": "latency_distribution",
"data_source": "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": "histogram",
"style": {
"palette": "dog_classic"
}
}
]
},
"layout": {
"x": 8,
"y": 0,
"width": 4,
"height": 2
}
}
],
"layout_type": "ordered"
}
EOF
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"title": "Example-Dashboard",
"description": "Example-Dashboard",
"widgets": [
{
"definition": {
"title": "Events Platform - Request latency HOP",
"title_size": "16",
"title_align": "left",
"show_legend": false,
"type": "distribution",
"xaxis": {
"max": "auto",
"include_zero": true,
"scale": "linear",
"min": "auto"
},
"yaxis": {
"max": "auto",
"include_zero": true,
"scale": "linear",
"min": "auto"
},
"requests": [
{
"query": {
"search": {
"query": ""
},
"data_source": "events",
"compute": {
"metric": "@duration",
"aggregation": "min"
},
"name": "query1",
"indexes": [
"*"
],
"group_by": []
},
"request_type": "histogram"
}
]
},
"layout": {
"x": 0,
"y": 0,
"width": 4,
"height": 2
}
}
],
"layout_type": "ordered"
}
EOF
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"title": "Example-Dashboard",
"widgets": [
{
"definition": {
"title": "Metrics HOP",
"title_size": "16",
"title_align": "left",
"show_legend": false,
"type": "distribution",
"custom_links": [
{
"label": "Example",
"link": "https://example.org/"
}
],
"xaxis": {
"max": "auto",
"include_zero": true,
"scale": "linear",
"min": "auto"
},
"yaxis": {
"max": "auto",
"include_zero": true,
"scale": "linear",
"min": "auto"
},
"requests": [
{
"query": {
"query": "histogram:trace.Load{*}",
"data_source": "metrics",
"name": "query1"
},
"request_type": "histogram",
"style": {
"palette": "dog_classic"
}
}
]
},
"layout": {
"x": 0,
"y": 0,
"width": 4,
"height": 2
}
}
],
"layout_type": "ordered"
}
EOF
// Create a distribution widget using a histogram request containing a formulas and functions APM Stats query
package main
import (
"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"
)
func main() {
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)
if err != 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
package main
import (
"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"
)
func main() {
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)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.CreateDashboard`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.CreateDashboard`:\n%s\n", responseContent)
}
// Create a distribution widget using a histogram request containing a formulas and functions metrics query
package main
import (
"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"
)
func main() {
body := datadogV1.Dashboard{
Title: "Example-Dashboard",
Widgets: []datadogV1.Widget{
{
Definition: datadogV1.WidgetDefinition{
DistributionWidgetDefinition: &datadogV1.DistributionWidgetDefinition{
Title: datadog.PtrString("Metrics HOP"),
TitleSize: datadog.PtrString("16"),
TitleAlign: datadogV1.WIDGETTEXTALIGN_LEFT.Ptr(),
ShowLegend: datadog.PtrBool(false),
Type: datadogV1.DISTRIBUTIONWIDGETDEFINITIONTYPE_DISTRIBUTION,
CustomLinks: []datadogV1.WidgetCustomLink{
{
Label: datadog.PtrString("Example"),
Link: datadog.PtrString("https://example.org/"),
},
},
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{
FormulaAndFunctionMetricQueryDefinition: &datadogV1.FormulaAndFunctionMetricQueryDefinition{
Query: "histogram:trace.Load{*}",
DataSource: datadogV1.FORMULAANDFUNCTIONMETRICDATASOURCE_METRICS,
Name: "query1",
}},
RequestType: datadogV1.DISTRIBUTIONWIDGETHISTOGRAMREQUESTTYPE_HISTOGRAM.Ptr(),
Style: &datadogV1.WidgetStyle{
Palette: datadog.PtrString("dog_classic"),
},
},
},
}},
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)
if err != 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)
}
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"// Create a distribution widget using a histogram request containing a formulas and functions APM
// Stats query
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;
import com.datadog.api.client.v1.model.DashboardLayoutType;
import com.datadog.api.client.v1.model.DistributionWidgetDefinition;
import com.datadog.api.client.v1.model.DistributionWidgetDefinitionType;
import com.datadog.api.client.v1.model.DistributionWidgetHistogramRequestQuery;
import com.datadog.api.client.v1.model.DistributionWidgetHistogramRequestType;
import com.datadog.api.client.v1.model.DistributionWidgetRequest;
import com.datadog.api.client.v1.model.DistributionWidgetXAxis;
import com.datadog.api.client.v1.model.DistributionWidgetYAxis;
import com.datadog.api.client.v1.model.FormulaAndFunctionApmResourceStatName;
import com.datadog.api.client.v1.model.FormulaAndFunctionApmResourceStatsDataSource;
import com.datadog.api.client.v1.model.FormulaAndFunctionApmResourceStatsQueryDefinition;
import com.datadog.api.client.v1.model.Widget;
import com.datadog.api.client.v1.model.WidgetDefinition;
import com.datadog.api.client.v1.model.WidgetLayout;
import com.datadog.api.client.v1.model.WidgetStyle;
import com.datadog.api.client.v1.model.WidgetTextAlign;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
Dashboard body =
new Dashboard()
.title("Example-Dashboard")
.description("")
.widgets(
Collections.singletonList(
new Widget()
.definition(
new WidgetDefinition(
new DistributionWidgetDefinition()
.title("APM Stats - Request latency HOP")
.titleSize("16")
.titleAlign(WidgetTextAlign.LEFT)
.showLegend(false)
.type(DistributionWidgetDefinitionType.DISTRIBUTION)
.xaxis(
new DistributionWidgetXAxis()
.max("auto")
.includeZero(true)
.scale("linear")
.min("auto"))
.yaxis(
new DistributionWidgetYAxis()
.max("auto")
.includeZero(true)
.scale("linear")
.min("auto"))
.requests(
Collections.singletonList(
new DistributionWidgetRequest()
.query(
new DistributionWidgetHistogramRequestQuery(
new FormulaAndFunctionApmResourceStatsQueryDefinition()
.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(new WidgetStyle().palette("dog_classic"))))))
.layout(new WidgetLayout().x(8L).y(0L).width(4L).height(2L))))
.layoutType(DashboardLayoutType.ORDERED);
try {
Dashboard result = apiInstance.createDashboard(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardsApi#createDashboard");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
// Create a distribution widget using a histogram request containing a formulas and functions events
// query
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;
import com.datadog.api.client.v1.model.DashboardLayoutType;
import com.datadog.api.client.v1.model.DistributionWidgetDefinition;
import com.datadog.api.client.v1.model.DistributionWidgetDefinitionType;
import com.datadog.api.client.v1.model.DistributionWidgetHistogramRequestQuery;
import com.datadog.api.client.v1.model.DistributionWidgetHistogramRequestType;
import com.datadog.api.client.v1.model.DistributionWidgetRequest;
import com.datadog.api.client.v1.model.DistributionWidgetXAxis;
import com.datadog.api.client.v1.model.DistributionWidgetYAxis;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventAggregation;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinition;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionCompute;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionSearch;
import com.datadog.api.client.v1.model.FormulaAndFunctionEventsDataSource;
import com.datadog.api.client.v1.model.Widget;
import com.datadog.api.client.v1.model.WidgetDefinition;
import com.datadog.api.client.v1.model.WidgetLayout;
import com.datadog.api.client.v1.model.WidgetTextAlign;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
Dashboard body =
new Dashboard()
.title("Example-Dashboard")
.description("Example-Dashboard")
.widgets(
Collections.singletonList(
new Widget()
.definition(
new WidgetDefinition(
new DistributionWidgetDefinition()
.title("Events Platform - Request latency HOP")
.titleSize("16")
.titleAlign(WidgetTextAlign.LEFT)
.showLegend(false)
.type(DistributionWidgetDefinitionType.DISTRIBUTION)
.xaxis(
new DistributionWidgetXAxis()
.max("auto")
.includeZero(true)
.scale("linear")
.min("auto"))
.yaxis(
new DistributionWidgetYAxis()
.max("auto")
.includeZero(true)
.scale("linear")
.min("auto"))
.requests(
Collections.singletonList(
new DistributionWidgetRequest()
.query(
new DistributionWidgetHistogramRequestQuery(
new FormulaAndFunctionEventQueryDefinition()
.search(
new FormulaAndFunctionEventQueryDefinitionSearch()
.query(""))
.dataSource(
FormulaAndFunctionEventsDataSource
.EVENTS)
.compute(
new FormulaAndFunctionEventQueryDefinitionCompute()
.metric("@duration")
.aggregation(
FormulaAndFunctionEventAggregation
.MIN))
.name("query1")
.indexes(
Collections.singletonList("*"))))
.requestType(
DistributionWidgetHistogramRequestType
.HISTOGRAM)))))
.layout(new WidgetLayout().x(0L).y(0L).width(4L).height(2L))))
.layoutType(DashboardLayoutType.ORDERED);
try {
Dashboard result = apiInstance.createDashboard(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardsApi#createDashboard");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
// Create a distribution widget using a histogram request containing a formulas and functions
// metrics query
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;
import com.datadog.api.client.v1.model.DashboardLayoutType;
import com.datadog.api.client.v1.model.DistributionWidgetDefinition;
import com.datadog.api.client.v1.model.DistributionWidgetDefinitionType;
import com.datadog.api.client.v1.model.DistributionWidgetHistogramRequestQuery;
import com.datadog.api.client.v1.model.DistributionWidgetHistogramRequestType;
import com.datadog.api.client.v1.model.DistributionWidgetRequest;
import com.datadog.api.client.v1.model.DistributionWidgetXAxis;
import com.datadog.api.client.v1.model.DistributionWidgetYAxis;
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricDataSource;
import com.datadog.api.client.v1.model.FormulaAndFunctionMetricQueryDefinition;
import com.datadog.api.client.v1.model.Widget;
import com.datadog.api.client.v1.model.WidgetCustomLink;
import com.datadog.api.client.v1.model.WidgetDefinition;
import com.datadog.api.client.v1.model.WidgetLayout;
import com.datadog.api.client.v1.model.WidgetStyle;
import com.datadog.api.client.v1.model.WidgetTextAlign;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
Dashboard body =
new Dashboard()
.title("Example-Dashboard")
.widgets(
Collections.singletonList(
new Widget()
.definition(
new WidgetDefinition(
new DistributionWidgetDefinition()
.title("Metrics HOP")
.titleSize("16")
.titleAlign(WidgetTextAlign.LEFT)
.showLegend(false)
.type(DistributionWidgetDefinitionType.DISTRIBUTION)
.customLinks(
Collections.singletonList(
new WidgetCustomLink()
.label("Example")
.link("https://example.org/")))
.xaxis(
new DistributionWidgetXAxis()
.max("auto")
.includeZero(true)
.scale("linear")
.min("auto"))
.yaxis(
new DistributionWidgetYAxis()
.max("auto")
.includeZero(true)
.scale("linear")
.min("auto"))
.requests(
Collections.singletonList(
new DistributionWidgetRequest()
.query(
new DistributionWidgetHistogramRequestQuery(
new FormulaAndFunctionMetricQueryDefinition()
.query("histogram:trace.Load{*}")
.dataSource(
FormulaAndFunctionMetricDataSource
.METRICS)
.name("query1")))
.requestType(
DistributionWidgetHistogramRequestType
.HISTOGRAM)
.style(new WidgetStyle().palette("dog_classic"))))))
.layout(new WidgetLayout().x(0L).y(0L).width(4L).height(2L))))
.layoutType(DashboardLayoutType.ORDERED);
try {
Dashboard result = apiInstance.createDashboard(body);
System.out.println(result);
} catch (ApiException e) {
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();
}
}
}
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
title = 'Average Memory Free Shell'
widgets = [{
'definition': {
'type': 'timeseries',
'requests': [
{'q': 'avg:system.mem.free{*}'}
],
'title': 'Average Memory Free'
}
}]
layout_type = 'ordered'
description = 'A dashboard with memory info.'
is_read_only = True
notify_list = ['user@domain.com']
template_variables = [{
'name': 'host1',
'prefix': 'host',
'default': 'my-host'
}]
saved_views = [{
'name': 'Saved views for hostname 2',
'template_variables': [{'name': 'host', 'value': '<HOSTNAME_2>'}]}
]
api.Dashboard.create(title=title,
widgets=widgets,
layout_type=layout_type,
description=description,
is_read_only=is_read_only,
notify_list=notify_list,
template_variables=template_variables,
template_variable_presets=saved_view)
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py""""
Create a distribution widget using a histogram request containing a formulas and functions APM Stats query
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard import Dashboard
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
from datadog_api_client.v1.model.distribution_widget_definition import DistributionWidgetDefinition
from datadog_api_client.v1.model.distribution_widget_definition_type import DistributionWidgetDefinitionType
from datadog_api_client.v1.model.distribution_widget_histogram_request_type import (
DistributionWidgetHistogramRequestType,
)
from datadog_api_client.v1.model.distribution_widget_request import DistributionWidgetRequest
from datadog_api_client.v1.model.distribution_widget_x_axis import DistributionWidgetXAxis
from datadog_api_client.v1.model.distribution_widget_y_axis import DistributionWidgetYAxis
from datadog_api_client.v1.model.formula_and_function_apm_resource_stat_name import (
FormulaAndFunctionApmResourceStatName,
)
from datadog_api_client.v1.model.formula_and_function_apm_resource_stats_data_source import (
FormulaAndFunctionApmResourceStatsDataSource,
)
from datadog_api_client.v1.model.formula_and_function_apm_resource_stats_query_definition import (
FormulaAndFunctionApmResourceStatsQueryDefinition,
)
from datadog_api_client.v1.model.widget import Widget
from datadog_api_client.v1.model.widget_layout import WidgetLayout
from datadog_api_client.v1.model.widget_style import WidgetStyle
from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign
body = 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()
with ApiClient(configuration) as api_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
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard import Dashboard
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
from datadog_api_client.v1.model.distribution_widget_definition import DistributionWidgetDefinition
from datadog_api_client.v1.model.distribution_widget_definition_type import DistributionWidgetDefinitionType
from datadog_api_client.v1.model.distribution_widget_histogram_request_type import (
DistributionWidgetHistogramRequestType,
)
from datadog_api_client.v1.model.distribution_widget_request import DistributionWidgetRequest
from datadog_api_client.v1.model.distribution_widget_x_axis import DistributionWidgetXAxis
from datadog_api_client.v1.model.distribution_widget_y_axis import DistributionWidgetYAxis
from datadog_api_client.v1.model.formula_and_function_event_aggregation import FormulaAndFunctionEventAggregation
from datadog_api_client.v1.model.formula_and_function_event_query_definition import (
FormulaAndFunctionEventQueryDefinition,
)
from datadog_api_client.v1.model.formula_and_function_event_query_definition_compute import (
FormulaAndFunctionEventQueryDefinitionCompute,
)
from datadog_api_client.v1.model.formula_and_function_event_query_definition_search import (
FormulaAndFunctionEventQueryDefinitionSearch,
)
from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource
from datadog_api_client.v1.model.widget import Widget
from datadog_api_client.v1.model.widget_layout import WidgetLayout
from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign
body = 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()
with ApiClient(configuration) as api_client:
api_instance = DashboardsApi(api_client)
response = api_instance.create_dashboard(body=body)
print(response)
"""
Create a distribution widget using a histogram request containing a formulas and functions metrics query
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard import Dashboard
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
from datadog_api_client.v1.model.distribution_widget_definition import DistributionWidgetDefinition
from datadog_api_client.v1.model.distribution_widget_definition_type import DistributionWidgetDefinitionType
from datadog_api_client.v1.model.distribution_widget_histogram_request_type import (
DistributionWidgetHistogramRequestType,
)
from datadog_api_client.v1.model.distribution_widget_request import DistributionWidgetRequest
from datadog_api_client.v1.model.distribution_widget_x_axis import DistributionWidgetXAxis
from datadog_api_client.v1.model.distribution_widget_y_axis import DistributionWidgetYAxis
from datadog_api_client.v1.model.formula_and_function_metric_data_source import FormulaAndFunctionMetricDataSource
from datadog_api_client.v1.model.formula_and_function_metric_query_definition import (
FormulaAndFunctionMetricQueryDefinition,
)
from datadog_api_client.v1.model.widget import Widget
from datadog_api_client.v1.model.widget_custom_link import WidgetCustomLink
from datadog_api_client.v1.model.widget_layout import WidgetLayout
from datadog_api_client.v1.model.widget_style import WidgetStyle
from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign
body = Dashboard(
title="Example-Dashboard",
widgets=[
Widget(
definition=DistributionWidgetDefinition(
title="Metrics HOP",
title_size="16",
title_align=WidgetTextAlign.LEFT,
show_legend=False,
type=DistributionWidgetDefinitionType.DISTRIBUTION,
custom_links=[
WidgetCustomLink(
label="Example",
link="https://example.org/",
),
],
xaxis=DistributionWidgetXAxis(
max="auto",
include_zero=True,
scale="linear",
min="auto",
),
yaxis=DistributionWidgetYAxis(
max="auto",
include_zero=True,
scale="linear",
min="auto",
),
requests=[
DistributionWidgetRequest(
query=FormulaAndFunctionMetricQueryDefinition(
query="histogram:trace.Load{*}",
data_source=FormulaAndFunctionMetricDataSource.METRICS,
name="query1",
),
request_type=DistributionWidgetHistogramRequestType.HISTOGRAM,
style=WidgetStyle(
palette="dog_classic",
),
),
],
),
layout=WidgetLayout(
x=0,
y=0,
width=4,
height=2,
),
),
],
layout_type=DashboardLayoutType.ORDERED,
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardsApi(api_client)
response = api_instance.create_dashboard(body=body)
print(response)
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Create a dashboard.
title = 'Average Memory Free Shell'
widgets = [{
'definition': {
'type' => 'timeseries',
'requests' => [
{'q' => 'avg:system.mem.free{*}'}
],
'title' => 'Average Memory Free'
}
}]
layout_type = 'ordered'
description = 'A dashboard with memory info.'
is_read_only = true
notify_list = ['user@domain.com']
template_variables = [{
'name' => 'host',
'prefix' => 'host',
'default' => '<HOSTNAME_1>'
}]
saved_view = [{
'name': 'Saved views for hostname 2',
'template_variables': [{'name': 'host', 'value': '<HOSTNAME_2>'}]}
]
dog.create_board(title, widgets, layout_type, {
:description => description,
:is_read_only => is_read_only,
:notify_list => notify_list,
:template_variables => template_variables,
:template_variable_presets => saved_view
})
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"# Create a distribution widget using a histogram request containing a formulas and functions APM Stats query
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
body = 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,
})
p api_instance.create_dashboard(body)
# Create a distribution widget using a histogram request containing a formulas and functions events query
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
body = 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,
})
p api_instance.create_dashboard(body)
# Create a distribution widget using a histogram request containing a formulas and functions metrics query
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
body = DatadogAPIClient::V1::Dashboard.new({
title: "Example-Dashboard",
widgets: [
DatadogAPIClient::V1::Widget.new({
definition: DatadogAPIClient::V1::DistributionWidgetDefinition.new({
title: "Metrics HOP",
title_size: "16",
title_align: DatadogAPIClient::V1::WidgetTextAlign::LEFT,
show_legend: false,
type: DatadogAPIClient::V1::DistributionWidgetDefinitionType::DISTRIBUTION,
custom_links: [
DatadogAPIClient::V1::WidgetCustomLink.new({
label: "Example",
link: "https://example.org/",
}),
],
xaxis: DatadogAPIClient::V1::DistributionWidgetXAxis.new({
max: "auto",
include_zero: true,
scale: "linear",
min: "auto",
}),
yaxis: DatadogAPIClient::V1::DistributionWidgetYAxis.new({
max: "auto",
include_zero: true,
scale: "linear",
min: "auto",
}),
requests: [
DatadogAPIClient::V1::DistributionWidgetRequest.new({
query: DatadogAPIClient::V1::FormulaAndFunctionMetricQueryDefinition.new({
query: "histogram:trace.Load{*}",
data_source: DatadogAPIClient::V1::FormulaAndFunctionMetricDataSource::METRICS,
name: "query1",
}),
request_type: DatadogAPIClient::V1::DistributionWidgetHistogramRequestType::HISTOGRAM,
style: DatadogAPIClient::V1::WidgetStyle.new({
palette: "dog_classic",
}),
}),
],
}),
layout: DatadogAPIClient::V1::WidgetLayout.new({
x: 0,
y: 0,
width: 4,
height: 2,
}),
}),
],
layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED,
})
p api_instance.create_dashboard(body)
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"/**
* Create a distribution widget using a histogram request containing a formulas and functions APM Stats query
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);
const params: 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";
const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);
const params: 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));
/**
* Create a distribution widget using a histogram request containing a formulas and functions metrics query
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);
const params: v1.DashboardsApiCreateDashboardRequest = {
body: {
title: "Example-Dashboard",
widgets: [
{
definition: {
title: "Metrics HOP",
titleSize: "16",
titleAlign: "left",
showLegend: false,
type: "distribution",
customLinks: [
{
label: "Example",
link: "https://example.org/",
},
],
xaxis: {
max: "auto",
includeZero: true,
scale: "linear",
min: "auto",
},
yaxis: {
max: "auto",
includeZero: true,
scale: "linear",
min: "auto",
},
requests: [
{
query: {
query: "histogram:trace.Load{*}",
dataSource: "metrics",
name: "query1",
},
requestType: "histogram",
style: {
palette: "dog_classic",
},
},
],
},
layout: {
x: 0,
y: 0,
width: 4,
height: 2,
},
},
],
layoutType: "ordered",
},
};
apiInstance
.createDashboard(params)
.then((data: v1.Dashboard) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"GET https://api.ap1.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.datadoghq.eu/api/v1/dashboard/{dashboard_id}https://api.ddog-gov.com/api/v1/dashboard/{dashboard_id}https://api.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.us3.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.us5.datadoghq.com/api/v1/dashboard/{dashboard_id}
Get a dashboard using the specified ID.
This endpoint requires the dashboards_read authorization scope.
이름
유형
설명
dashboard_id [required]
string
The ID of the dashboard.
OK
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.
항목
유형
설명
author_handle
string
Identifier of the dashboard author.
author_name
string
Name of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
ID of the dashboard.
is_read_only
boolean
DEPRECATED: Whether this dashboard is read-only. If True, only the author and admins can make changes to it. Prefer using restricted_roles to manage write authorization.
layout_type [required]
enum
Layout type of the dashboard.
Allowed enum values: ordered,free
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
reflow_type
enum
Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'.
If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto',
widgets should not have layouts.
Allowed enum values: auto,fixed
restricted_roles
[string]
A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
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.
title [required]
string
Title of the dashboard.
url
string
The URL of the dashboard.
widgets [required]
[object]
List of widgets to display on the dashboard.
id
int64
ID of the widget.
layout
object
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.
{
"author_handle": "test@datadoghq.com",
"author_name": "John Doe",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"id": "123-abc-456",
"is_read_only": false,
"layout_type": "ordered",
"modified_at": "2019-09-19T10:00:00.000Z",
"notify_list": [],
"reflow_type": "string",
"restricted_roles": [],
"tags": [],
"template_variable_presets": [
{
"name": "string",
"template_variables": [
{
"name": "string",
"value": "string",
"values": []
}
]
}
],
"template_variables": [
{
"available_values": [
"my-host",
"host1",
"host2"
],
"default": "my-host",
"defaults": [
"my-host-1",
"my-host-2"
],
"name": "host1",
"prefix": "host"
}
],
"title": "",
"url": "/dashboard/123-abc-456/example-dashboard-title",
"widgets": [
{
"definition": {
"requests": {
"fill": {
"q": "avg:system.cpu.user{*}"
}
},
"type": "hostmap"
},
"id": "integer",
"layout": {
"height": 0,
"is_column_break": false,
"width": 0,
"x": 0,
"y": 0
}
}
]
}Authentication Error
Error response object.
{
"errors": [
"Bad Request"
]
}Item Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export dashboard_id="CHANGE_ME"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Get a dashboard returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
# there is a valid "dashboard" in the system
DASHBOARD_ID = environ["DASHBOARD_ID"]
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardsApi(api_client)
response = api_instance.get_dashboard(
dashboard_id=DASHBOARD_ID,
)
print(response)
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"# Get a dashboard returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
# there is a valid "dashboard" in the system
DASHBOARD_ID = ENV["DASHBOARD_ID"]
p api_instance.get_dashboard(DASHBOARD_ID)
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dashboard_id = '<DASHBOARD_ID>'
dog.get_board(dashboard_id)
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"// Get a dashboard returns "OK" response
package main
import (
"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"
)
func main() {
// 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)
if err != 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)
}
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"// Get a dashboard returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
// there is a valid "dashboard" in the system
String DASHBOARD_ID = System.getenv("DASHBOARD_ID");
try {
Dashboard result = apiInstance.getDashboard(DASHBOARD_ID);
System.out.println(result);
} catch (ApiException e) {
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();
}
}
}
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
dashboard_id = '<DASHBOARD_ID>'
api.Dashboard.get(dashboard_id)
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"/**
* Get a dashboard returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);
// there is a valid "dashboard" in the system
const DASHBOARD_ID = process.env.DASHBOARD_ID as string;
const params: 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));
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"GET https://api.ap1.datadoghq.com/api/v1/dashboardhttps://api.datadoghq.eu/api/v1/dashboardhttps://api.ddog-gov.com/api/v1/dashboardhttps://api.datadoghq.com/api/v1/dashboardhttps://api.us3.datadoghq.com/api/v1/dashboardhttps://api.us5.datadoghq.com/api/v1/dashboard
Get all dashboards.
Note: This query will only return custom created or cloned dashboards. This query will not return preset dashboards.
This endpoint requires thedashboards_read authorization scope.이름
유형
설명
filter[shared]
boolean
When true, this query only returns shared custom created
or cloned dashboards.
filter[deleted]
boolean
When true, this query returns only deleted custom-created
or cloned dashboards. This parameter is incompatible with filter[shared].
count
integer
The maximum number of dashboards returned in the list.
start
integer
The specific offset to use as the beginning of the returned response.
OK
Dashboard summary response.
항목
유형
설명
dashboards
[object]
List of dashboard definitions.
author_handle
string
Identifier of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
Dashboard identifier.
is_read_only
boolean
Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
layout_type
enum
Layout type of the dashboard.
Allowed enum values: ordered,free
modified_at
date-time
Modification date of the dashboard.
title
string
Title of the dashboard.
url
string
URL of the dashboard.
{
"dashboards": [
{
"author_handle": "string",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"id": "string",
"is_read_only": false,
"layout_type": "ordered",
"modified_at": "2019-09-19T10:00:00.000Z",
"title": "string",
"url": "string"
}
]
}Authentication Error
Error response object.
{
"errors": [
"Bad Request"
]
}Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Get all dashboards returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardsApi(api_client)
response = api_instance.list_dashboards(
filter_shared=False,
)
print(response)
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"# Get all dashboards returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
opts = {
filter_shared: false,
}
p api_instance.list_dashboards(opts)
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.get_all_boards()
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"// Get all dashboards returns "OK" response
package main
import (
"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"
)
func main() {
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))
if err != 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)
}
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"// Get all dashboards returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.api.DashboardsApi.ListDashboardsOptionalParameters;
import com.datadog.api.client.v1.model.DashboardSummary;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
try {
DashboardSummary result =
apiInstance.listDashboards(new ListDashboardsOptionalParameters().filterShared(false));
System.out.println(result);
} catch (ApiException e) {
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();
}
}
}
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
api.Dashboard.get_all()
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"/**
* Get all dashboards returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);
const params: 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));
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"PUT https://api.ap1.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.datadoghq.eu/api/v1/dashboard/{dashboard_id}https://api.ddog-gov.com/api/v1/dashboard/{dashboard_id}https://api.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.us3.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.us5.datadoghq.com/api/v1/dashboard/{dashboard_id}
Update a dashboard using the specified ID.
This endpoint requires the dashboards_write authorization scope.
이름
유형
설명
dashboard_id [required]
string
The ID of the dashboard.
Update Dashboard request body.
항목
유형
설명
author_handle
string
Identifier of the dashboard author.
author_name
string
Name of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
ID of the dashboard.
is_read_only
boolean
DEPRECATED: Whether this dashboard is read-only. If True, only the author and admins can make changes to it. Prefer using restricted_roles to manage write authorization.
layout_type [required]
enum
Layout type of the dashboard.
Allowed enum values: ordered,free
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
reflow_type
enum
Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'.
If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto',
widgets should not have layouts.
Allowed enum values: auto,fixed
restricted_roles
[string]
A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
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.
title [required]
string
Title of the dashboard.
url
string
The URL of the dashboard.
widgets [required]
[object]
List of widgets to display on the dashboard.
id
int64
ID of the widget.
layout
object
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"
}
]
}
}
]
}OK
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.
항목
유형
설명
author_handle
string
Identifier of the dashboard author.
author_name
string
Name of the dashboard author.
created_at
date-time
Creation date of the dashboard.
description
string
Description of the dashboard.
id
string
ID of the dashboard.
is_read_only
boolean
DEPRECATED: Whether this dashboard is read-only. If True, only the author and admins can make changes to it. Prefer using restricted_roles to manage write authorization.
layout_type [required]
enum
Layout type of the dashboard.
Allowed enum values: ordered,free
modified_at
date-time
Modification date of the dashboard.
notify_list
[string]
List of handles of users to notify when changes are made to this dashboard.
reflow_type
enum
Reflow type for a new dashboard layout dashboard. Set this only when layout type is 'ordered'.
If set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto',
widgets should not have layouts.
Allowed enum values: auto,fixed
restricted_roles
[string]
A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
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.
title [required]
string
Title of the dashboard.
url
string
The URL of the dashboard.
widgets [required]
[object]
List of widgets to display on the dashboard.
id
int64
ID of the widget.
layout
object
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.
{
"author_handle": "test@datadoghq.com",
"author_name": "John Doe",
"created_at": "2019-09-19T10:00:00.000Z",
"description": "string",
"id": "123-abc-456",
"is_read_only": false,
"layout_type": "ordered",
"modified_at": "2019-09-19T10:00:00.000Z",
"notify_list": [],
"reflow_type": "string",
"restricted_roles": [],
"tags": [],
"template_variable_presets": [
{
"name": "string",
"template_variables": [
{
"name": "string",
"value": "string",
"values": []
}
]
}
],
"template_variables": [
{
"available_values": [
"my-host",
"host1",
"host2"
],
"default": "my-host",
"defaults": [
"my-host-1",
"my-host-2"
],
"name": "host1",
"prefix": "host"
}
],
"title": "",
"url": "/dashboard/123-abc-456/example-dashboard-title",
"widgets": [
{
"definition": {
"requests": {
"fill": {
"q": "avg:system.cpu.user{*}"
}
},
"type": "hostmap"
},
"id": "integer",
"layout": {
"height": 0,
"is_column_break": false,
"width": 0,
"x": 0,
"y": 0
}
}
]
}Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}Authentication Error
Error response object.
{
"errors": [
"Bad Request"
]
}Item Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export dashboard_id="CHANGE_ME"
# Curl command
curl -X PUT "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"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"
}
]
}
}
]
}
EOF
# Path parameters
export dashboard_id="CHANGE_ME"
# Curl command
curl -X PUT "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"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"
}
]
}
}
]
}
EOF
// Update a dashboard returns "OK" response
package main
import (
"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"
)
func main() {
// 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)
if err != 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
package main
import (
"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"
)
func main() {
// 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)
if err != 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)
}
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"// Update a dashboard returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;
import com.datadog.api.client.v1.model.DashboardLayoutType;
import com.datadog.api.client.v1.model.ListStreamColumn;
import com.datadog.api.client.v1.model.ListStreamColumnWidth;
import com.datadog.api.client.v1.model.ListStreamQuery;
import com.datadog.api.client.v1.model.ListStreamResponseFormat;
import com.datadog.api.client.v1.model.ListStreamSource;
import com.datadog.api.client.v1.model.ListStreamWidgetDefinition;
import com.datadog.api.client.v1.model.ListStreamWidgetDefinitionType;
import com.datadog.api.client.v1.model.ListStreamWidgetRequest;
import com.datadog.api.client.v1.model.Widget;
import com.datadog.api.client.v1.model.WidgetDefinition;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
// there is a valid "dashboard" in the system
String DASHBOARD_ID = System.getenv("DASHBOARD_ID");
Dashboard body =
new Dashboard()
.layoutType(DashboardLayoutType.ORDERED)
.title("Example-Dashboard with list_stream widget")
.description("Updated description")
.widgets(
Collections.singletonList(
new Widget()
.definition(
new WidgetDefinition(
new ListStreamWidgetDefinition()
.type(ListStreamWidgetDefinitionType.LIST_STREAM)
.requests(
Collections.singletonList(
new ListStreamWidgetRequest()
.columns(
Collections.singletonList(
new ListStreamColumn()
.width(ListStreamColumnWidth.AUTO)
.field("timestamp")))
.query(
new ListStreamQuery()
.dataSource(
ListStreamSource.APM_ISSUE_STREAM)
.queryString(""))
.responseFormat(
ListStreamResponseFormat.EVENT_LIST)))))));
try {
Dashboard result = apiInstance.updateDashboard(DASHBOARD_ID, body);
System.out.println(result);
} catch (ApiException e) {
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" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.Dashboard;
import com.datadog.api.client.v1.model.DashboardLayoutType;
import com.datadog.api.client.v1.model.ListStreamColumn;
import com.datadog.api.client.v1.model.ListStreamColumnWidth;
import com.datadog.api.client.v1.model.ListStreamQuery;
import com.datadog.api.client.v1.model.ListStreamResponseFormat;
import com.datadog.api.client.v1.model.ListStreamSource;
import com.datadog.api.client.v1.model.ListStreamWidgetDefinition;
import com.datadog.api.client.v1.model.ListStreamWidgetDefinitionType;
import com.datadog.api.client.v1.model.ListStreamWidgetRequest;
import com.datadog.api.client.v1.model.Widget;
import com.datadog.api.client.v1.model.WidgetDefinition;
import java.util.Arrays;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
// there is a valid "dashboard" in the system
String DASHBOARD_ID = System.getenv("DASHBOARD_ID");
Dashboard body =
new Dashboard()
.layoutType(DashboardLayoutType.ORDERED)
.title("Example-Dashboard with list_stream widget")
.description("Updated description")
.tags(Arrays.asList("team:foo", "team:bar"))
.widgets(
Collections.singletonList(
new Widget()
.definition(
new WidgetDefinition(
new ListStreamWidgetDefinition()
.type(ListStreamWidgetDefinitionType.LIST_STREAM)
.requests(
Collections.singletonList(
new ListStreamWidgetRequest()
.columns(
Collections.singletonList(
new ListStreamColumn()
.width(ListStreamColumnWidth.AUTO)
.field("timestamp")))
.query(
new ListStreamQuery()
.dataSource(
ListStreamSource.APM_ISSUE_STREAM)
.queryString(""))
.responseFormat(
ListStreamResponseFormat.EVENT_LIST)))))));
try {
Dashboard result = apiInstance.updateDashboard(DASHBOARD_ID, body);
System.out.println(result);
} catch (ApiException e) {
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();
}
}
}
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java""""
Update a dashboard returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard import Dashboard
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
from datadog_api_client.v1.model.list_stream_column import ListStreamColumn
from datadog_api_client.v1.model.list_stream_column_width import ListStreamColumnWidth
from datadog_api_client.v1.model.list_stream_query import ListStreamQuery
from datadog_api_client.v1.model.list_stream_response_format import ListStreamResponseFormat
from datadog_api_client.v1.model.list_stream_source import ListStreamSource
from datadog_api_client.v1.model.list_stream_widget_definition import ListStreamWidgetDefinition
from datadog_api_client.v1.model.list_stream_widget_definition_type import ListStreamWidgetDefinitionType
from datadog_api_client.v1.model.list_stream_widget_request import ListStreamWidgetRequest
from datadog_api_client.v1.model.widget import Widget
# there is a valid "dashboard" in the system
DASHBOARD_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()
with ApiClient(configuration) as api_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
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard import Dashboard
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
from datadog_api_client.v1.model.list_stream_column import ListStreamColumn
from datadog_api_client.v1.model.list_stream_column_width import ListStreamColumnWidth
from datadog_api_client.v1.model.list_stream_query import ListStreamQuery
from datadog_api_client.v1.model.list_stream_response_format import ListStreamResponseFormat
from datadog_api_client.v1.model.list_stream_source import ListStreamSource
from datadog_api_client.v1.model.list_stream_widget_definition import ListStreamWidgetDefinition
from datadog_api_client.v1.model.list_stream_widget_definition_type import ListStreamWidgetDefinitionType
from datadog_api_client.v1.model.list_stream_widget_request import ListStreamWidgetRequest
from datadog_api_client.v1.model.widget import Widget
# there is a valid "dashboard" in the system
DASHBOARD_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()
with ApiClient(configuration) as api_client:
api_instance = DashboardsApi(api_client)
response = api_instance.update_dashboard(dashboard_id=DASHBOARD_ID, body=body)
print(response)
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"# Update a dashboard returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
# there is a valid "dashboard" in the system
DASHBOARD_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,
}),
],
}),
}),
],
})
p api_instance.update_dashboard(DASHBOARD_ID, body)
# Update a dashboard with tags returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
# there is a valid "dashboard" in the system
DASHBOARD_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,
}),
],
}),
}),
],
})
p api_instance.update_dashboard(DASHBOARD_ID, body)
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"/**
* Update a dashboard returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);
// there is a valid "dashboard" in the system
const DASHBOARD_ID = process.env.DASHBOARD_ID as string;
const params: 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";
const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);
// there is a valid "dashboard" in the system
const DASHBOARD_ID = process.env.DASHBOARD_ID as string;
const params: 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));
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"DELETE https://api.ap1.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.datadoghq.eu/api/v1/dashboard/{dashboard_id}https://api.ddog-gov.com/api/v1/dashboard/{dashboard_id}https://api.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.us3.datadoghq.com/api/v1/dashboard/{dashboard_id}https://api.us5.datadoghq.com/api/v1/dashboard/{dashboard_id}
Delete a dashboard using the specified ID.
This endpoint requires the dashboards_write authorization scope.
이름
유형
설명
dashboard_id [required]
string
The ID of the dashboard.
OK
Response from the delete dashboard call.
{
"deleted_dashboard_id": "string"
}Authentication Error
Error response object.
{
"errors": [
"Bad Request"
]
}Dashboards Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export dashboard_id="CHANGE_ME"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard/${dashboard_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Delete a dashboard returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
# there is a valid "dashboard" in the system
DASHBOARD_ID = environ["DASHBOARD_ID"]
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardsApi(api_client)
response = api_instance.delete_dashboard(
dashboard_id=DASHBOARD_ID,
)
print(response)
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"# Delete a dashboard returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
# there is a valid "dashboard" in the system
DASHBOARD_ID = ENV["DASHBOARD_ID"]
p api_instance.delete_dashboard(DASHBOARD_ID)
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dashboard_id = '<DASHBOARD_ID>'
dog.delete_board(dashboard_id)
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"// Delete a dashboard returns "OK" response
package main
import (
"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"
)
func main() {
// 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)
if err != 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)
}
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"// Delete a dashboard returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.DashboardDeleteResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
// there is a valid "dashboard" in the system
String DASHBOARD_ID = System.getenv("DASHBOARD_ID");
try {
DashboardDeleteResponse result = apiInstance.deleteDashboard(DASHBOARD_ID);
System.out.println(result);
} catch (ApiException e) {
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();
}
}
}
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"from datadog import initialize, api
options = {
'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_KEY>'
}
initialize(**options)
dashboard_id = '<DASHBOARD_ID>'
api.Dashboard.delete(dashboard_id)
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python "example.py"/**
* Delete a dashboard returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);
// there is a valid "dashboard" in the system
const DASHBOARD_ID = process.env.DASHBOARD_ID as string;
const params: 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));
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"DELETE https://api.ap1.datadoghq.com/api/v1/dashboardhttps://api.datadoghq.eu/api/v1/dashboardhttps://api.ddog-gov.com/api/v1/dashboardhttps://api.datadoghq.com/api/v1/dashboardhttps://api.us3.datadoghq.com/api/v1/dashboardhttps://api.us5.datadoghq.com/api/v1/dashboard
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 authorization scope.
Delete dashboards request body.
항목
유형
설명
data [required]
[object]
List of dashboard bulk action request data objects.
id [required]
string
Dashboard resource ID.
type [required]
enum
Dashboard resource type.
Allowed enum values: dashboard
default: dashboard
{
"data": [
{
"id": "123-abc-456",
"type": "dashboard"
}
]
}No Content
Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}Dashboards Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
## json-request-body
#
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": [
{
"id": "123-abc-456",
"type": "dashboard"
},
{
"id": "789-def-101",
"type": "dashboard"
}
]
}
EOF
// Delete dashboards returns "No Content" response
package main
import (
"context"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)
func main() {
// 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)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.DeleteDashboards`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"// Delete dashboards returns "No Content" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.DashboardBulkActionData;
import com.datadog.api.client.v1.model.DashboardBulkDeleteRequest;
import com.datadog.api.client.v1.model.DashboardResourceType;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
// there is a valid "dashboard" in the system
String DASHBOARD_ID = System.getenv("DASHBOARD_ID");
DashboardBulkDeleteRequest body =
new DashboardBulkDeleteRequest()
.data(
Collections.singletonList(
new DashboardBulkActionData()
.id(DASHBOARD_ID)
.type(DashboardResourceType.DASHBOARD)));
try {
apiInstance.deleteDashboards(body);
} catch (ApiException e) {
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();
}
}
}
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java""""
Delete dashboards returns "No Content" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard_bulk_action_data import DashboardBulkActionData
from datadog_api_client.v1.model.dashboard_bulk_action_data_list import DashboardBulkActionDataList
from datadog_api_client.v1.model.dashboard_bulk_delete_request import DashboardBulkDeleteRequest
from datadog_api_client.v1.model.dashboard_resource_type import DashboardResourceType
# there is a valid "dashboard" in the system
DASHBOARD_ID = environ["DASHBOARD_ID"]
body = DashboardBulkDeleteRequest(
data=DashboardBulkActionDataList(
[
DashboardBulkActionData(
id=DASHBOARD_ID,
type=DashboardResourceType.DASHBOARD,
),
]
),
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardsApi(api_client)
api_instance.delete_dashboards(body=body)
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"# Delete dashboards returns "No Content" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
# there is a valid "dashboard" in the system
DASHBOARD_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)
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"/**
* Delete dashboards returns "No Content" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);
// there is a valid "dashboard" in the system
const DASHBOARD_ID = process.env.DASHBOARD_ID as string;
const params: 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));
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"PATCH https://api.ap1.datadoghq.com/api/v1/dashboardhttps://api.datadoghq.eu/api/v1/dashboardhttps://api.ddog-gov.com/api/v1/dashboardhttps://api.datadoghq.com/api/v1/dashboardhttps://api.us3.datadoghq.com/api/v1/dashboardhttps://api.us5.datadoghq.com/api/v1/dashboard
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 authorization scope.
Restore dashboards request body.
항목
유형
설명
data [required]
[object]
List of dashboard bulk action request data objects.
id [required]
string
Dashboard resource ID.
type [required]
enum
Dashboard resource type.
Allowed enum values: dashboard
default: dashboard
{
"data": [
{
"id": "123-abc-456",
"type": "dashboard"
}
]
}No Content
Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}Forbidden
Error response object.
{
"errors": [
"Bad Request"
]
}Dashboards Not Found
Error response object.
{
"errors": [
"Bad Request"
]
}Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
## json-request-body
#
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/dashboard" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": [
{
"id": "123-abc-456",
"type": "dashboard"
},
{
"id": "789-def-101",
"type": "dashboard"
}
]
}
EOF
// Restore deleted dashboards returns "No Content" response
package main
import (
"context"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)
func main() {
// 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)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.RestoreDashboards`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"// Restore deleted dashboards returns "No Content" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v1.api.DashboardsApi;
import com.datadog.api.client.v1.model.DashboardBulkActionData;
import com.datadog.api.client.v1.model.DashboardResourceType;
import com.datadog.api.client.v1.model.DashboardRestoreRequest;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
// there is a valid "dashboard" in the system
String DASHBOARD_ID = System.getenv("DASHBOARD_ID");
DashboardRestoreRequest body =
new DashboardRestoreRequest()
.data(
Collections.singletonList(
new DashboardBulkActionData()
.id(DASHBOARD_ID)
.type(DashboardResourceType.DASHBOARD)));
try {
apiInstance.restoreDashboards(body);
} catch (ApiException e) {
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();
}
}
}
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java""""
Restore deleted dashboards returns "No Content" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
from datadog_api_client.v1.model.dashboard_bulk_action_data import DashboardBulkActionData
from datadog_api_client.v1.model.dashboard_bulk_action_data_list import DashboardBulkActionDataList
from datadog_api_client.v1.model.dashboard_resource_type import DashboardResourceType
from datadog_api_client.v1.model.dashboard_restore_request import DashboardRestoreRequest
# there is a valid "dashboard" in the system
DASHBOARD_ID = environ["DASHBOARD_ID"]
body = DashboardRestoreRequest(
data=DashboardBulkActionDataList(
[
DashboardBulkActionData(
id=DASHBOARD_ID,
type=DashboardResourceType.DASHBOARD,
),
]
),
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = DashboardsApi(api_client)
api_instance.restore_dashboards(body=body)
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"# Restore deleted dashboards returns "No Content" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
# there is a valid "dashboard" in the system
DASHBOARD_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)
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"/**
* Restore deleted dashboards returns "No Content" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v1.DashboardsApi(configuration);
// there is a valid "dashboard" in the system
const DASHBOARD_ID = process.env.DASHBOARD_ID as string;
const params: 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));
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"