Create a shared dashboard
POST
https://api.datadoghq.com/api/v1/dashboard/publichttps://api.us3.datadoghq.com/api/v1/dashboard/publichttps://api.us5.datadoghq.com/api/v1/dashboard/publichttps://api.datadoghq.eu/api/v1/dashboard/publichttps://api.ap1.datadoghq.com/api/v1/dashboard/publichttps://api.ap2.datadoghq.com/api/v1/dashboard/publichttps://api.uk1.datadoghq.com/api/v1/dashboard/publichttps://api.ddog-gov.com/api/v1/dashboard/publichttps://api.us2.ddog-gov.com/api/v1/dashboard/publicOverview
Share a specified private dashboard, generating a URL at which it can be publicly viewed.
This endpoint requires any of the following permissions:
dashboards_public_sharedashboards_embed_sharedashboards_invite_share
OAuth apps require one of the following authorization scopes to access this endpoint: dashboards_public_share, dashboards_embed_share, dashboards_invite_share.
Request
Body Data (required)
Create a shared dashboard request body.
Field
Type
Description
dashboard_id [required]string
ID of the dashboard to share.
dashboard_type [required]enum
The type of the associated private dashboard.
Allowed enum values:
custom_timeboard, custom_screenboardembeddable_domains[string]
The SharedDashboard embeddable_domains.
expirationdate-time
The time when an OPEN shared dashboard becomes publicly unavailable.
global_timeobject
Object containing the live span selection for the dashboard.
live_spanenum
Dashboard global time live_span selection
Allowed enum values:
15m, 1h, 4h, 1d, 2d, 1w, 1mo, 3moglobal_time_selectable_enabledboolean
Whether to allow viewers to select a different global time setting for the shared dashboard.
invitees[object]
The SharedDashboard invitees.
access_expirationdate-time
Time of the invitee expiration. Null means the invite will not expire.
email [required]string
Email of the invitee.
selectable_template_vars[object]
List of objects representing template variables on the shared dashboard which can have selectable values.
default_valuestring
The default value of the template variable.
namestring
Name of the template variable.
prefixstring
The tag/attribute key associated with the template variable.
typestring
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
visible_tags[string]
List of visible tag values on the shared dashboard.
share_list[string]
DEPRECATED List of email addresses that can receive an invitation to access to the shared dashboard.
share_typeenum
Type of sharing access (either open to anyone who has the public URL or invite-only).
Allowed enum values:
open, invite, embedstatusenum
Active means the dashboard is publicly available. Paused means the dashboard is not publicly available.
Allowed enum values:
active, pausedtitlestring
Title of the shared dashboard.
viewing_preferencesobject
The viewing preferences for a shared dashboard.
high_densityboolean
Whether the widgets on the shared dashboard should be displayed with high density.
themeenum
The theme of the shared dashboard view. "system" follows your system's default viewing theme.
Allowed enum values:
system, light, darkdefault
{
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"global_time": {
"live_span": "1h"
},
"share_type": "open"
}json-request-body
{
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"share_type": "open"
}Response
OK
The metadata object associated with how a dashboard has been/will be shared.
Field
Type
Description
authorobject
User who shared the dashboard.
handlestring
Identifier of the user who shared the dashboard.
namestring
Name of the user who shared the dashboard.
createddate-time
Date the dashboard was shared.
dashboard_id [required]string
ID of the dashboard to share.
dashboard_type [required]enum
The type of the associated private dashboard.
Allowed enum values:
custom_timeboard, custom_screenboardembeddable_domains[string]
The SharedDashboard embeddable_domains.
expirationdate-time
The time when an OPEN shared dashboard becomes publicly unavailable.
global_timeobject
Object containing the live span selection for the dashboard.
live_spanenum
Dashboard global time live_span selection
Allowed enum values:
15m, 1h, 4h, 1d, 2d, 1w, 1mo, 3moglobal_time_selectable_enabledboolean
Whether to allow viewers to select a different global time setting for the shared dashboard.
invitees[object]
The SharedDashboard invitees.
access_expirationdate-time
Time of the invitee expiration. Null means the invite will not expire.
created_atdate-time
Time that the invitee was created.
email [required]string
Email of the invitee.
last_accesseddate-time
The last time the shared dashboard was accessed. Null if never accessed.
public_urlstring
URL of the shared dashboard.
selectable_template_vars[object]
List of objects representing template variables on the shared dashboard which can have selectable values.
default_valuestring
The default value of the template variable.
namestring
Name of the template variable.
prefixstring
The tag/attribute key associated with the template variable.
typestring
The type of variable. This is to differentiate between filter variables (interpolated in query) and group by variables (interpolated into group by).
visible_tags[string]
List of visible tag values on the shared dashboard.
share_list[string]
DEPRECATED List of email addresses that can receive an invitation to access to the shared dashboard.
share_typeenum
Type of sharing access (either open to anyone who has the public URL or invite-only).
Allowed enum values:
open, invite, embedstatusenum
Active means the dashboard is publicly available. Paused means the dashboard is not publicly available.
Allowed enum values:
active, pausedtitlestring
Title of the shared dashboard.
tokenstring
A unique token assigned to the shared dashboard.
viewing_preferencesobject
The viewing preferences for a shared dashboard.
high_densityboolean
Whether the widgets on the shared dashboard should be displayed with high density.
themeenum
The theme of the shared dashboard view. "system" follows your system's default viewing theme.
Allowed enum values:
system, light, dark{
"author": {
"handle": "test@datadoghq.com",
"name": "string"
},
"created": "2019-09-19T10:00:00.000Z",
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"embeddable_domains": [
"https://domain.atlassian.net/",
"http://myserver.com/"
],
"expiration": "2019-09-19T10:00:00.000Z",
"global_time": {
"live_span": "1h"
},
"global_time_selectable_enabled": false,
"invitees": [
{
"access_expiration": "2019-09-19T10:00:00.000Z",
"created_at": "2019-09-19T10:00:00.000Z",
"email": "test@datadoghq.com"
}
],
"last_accessed": "2019-09-19T10:00:00.000Z",
"public_url": "string",
"selectable_template_vars": [
{
"default_value": "*",
"name": "exampleVar",
"prefix": "test",
"type": "string",
"visible_tags": [
"selectableValue1",
"selectableValue2"
]
}
],
"share_list": [
"test@datadoghq.com",
"test2@email.com"
],
"share_type": "string",
"status": "active",
"title": "string",
"token": "string",
"viewing_preferences": {
"high_density": false,
"theme": "string"
}
}Bad Request
Error response object.
Field
Type
Description
errors [required][string]
Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}Forbidden
Error response object.
Field
Type
Description
errors [required][string]
Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}Dashboard Not Found
Error response object.
Field
Type
Description
errors [required][string]
Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}Too many requests
Error response object.
Field
Type
Description
errors [required][string]
Array of errors returned by the API.
{
"errors": [
"Bad Request"
]
}Code Example
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/dashboard/public" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"global_time": {
"live_span": "1h"
},
"share_type": "open"
}
EOF# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/dashboard/public" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"global_time": {
"live_span": "1h"
},
"share_type": "open"
}
EOF# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/dashboard/public" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"global_time": {
"live_span": "1h"
},
"share_type": "open"
}
EOF# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/dashboard/public" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"global_time": {
"live_span": "1h"
},
"share_type": "open"
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/dashboard/public" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"global_time": {
"live_span": "1h"
},
"share_type": "open"
}
EOF# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/dashboard/public" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"global_time": {
"live_span": "1h"
},
"share_type": "open"
}
EOF# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/dashboard/public" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"global_time": {
"live_span": "1h"
},
"share_type": "open"
}
EOF# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/dashboard/public" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"global_time": {
"live_span": "1h"
},
"share_type": "open"
}
EOF# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v1/dashboard/public" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"dashboard_id": "123-abc-456",
"dashboard_type": "custom_timeboard",
"global_time": {
"live_span": "1h"
},
"share_type": "open"
}
EOFCreate a shared dashboard returns "OK" response
// Create a shared 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.SharedDashboard{
DashboardId: DashboardID,
DashboardType: datadogV1.DASHBOARDTYPE_CUSTOM_TIMEBOARD,
ShareType: *datadogV1.NewNullableDashboardShareType(datadogV1.DASHBOARDSHARETYPE_OPEN.Ptr()),
GlobalTime: &datadogV1.DashboardGlobalTime{
LiveSpan: datadogV1.DASHBOARDGLOBALTIMELIVESPAN_PAST_ONE_HOUR.Ptr(),
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV1.NewDashboardsApi(apiClient)
resp, r, err := api.CreatePublicDashboard(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.CreatePublicDashboard`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.CreatePublicDashboard`:\n%s\n", responseContent)
}
Create a shared dashboard with a group template variable returns "OK" response
// Create a shared dashboard with a group template variable 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.SharedDashboard{
DashboardId: DashboardID,
DashboardType: datadogV1.DASHBOARDTYPE_CUSTOM_TIMEBOARD,
ShareType: *datadogV1.NewNullableDashboardShareType(datadogV1.DASHBOARDSHARETYPE_OPEN.Ptr()),
GlobalTime: &datadogV1.DashboardGlobalTime{
LiveSpan: datadogV1.DASHBOARDGLOBALTIMELIVESPAN_PAST_ONE_HOUR.Ptr(),
},
SelectableTemplateVars: []datadogV1.SelectableTemplateVariableItems{
{
DefaultValue: datadog.PtrString("*"),
Name: datadog.PtrString("group_by_var"),
Type: *datadog.NewNullableString(datadog.PtrString("group")),
VisibleTags: *datadog.NewNullableList(&[]string{
"selectableValue1",
"selectableValue2",
}),
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV1.NewDashboardsApi(apiClient)
resp, r, err := api.CreatePublicDashboard(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DashboardsApi.CreatePublicDashboard`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `DashboardsApi.CreatePublicDashboard`:\n%s\n", responseContent)
}
Instructions
First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"Create a shared dashboard returns "OK" response
// Create a shared 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.DashboardGlobalTime;
import com.datadog.api.client.v1.model.DashboardGlobalTimeLiveSpan;
import com.datadog.api.client.v1.model.DashboardShareType;
import com.datadog.api.client.v1.model.DashboardType;
import com.datadog.api.client.v1.model.SharedDashboard;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
// there is a valid "dashboard" in the system
String DASHBOARD_ID = System.getenv("DASHBOARD_ID");
SharedDashboard body =
new SharedDashboard()
.dashboardId(DASHBOARD_ID)
.dashboardType(DashboardType.CUSTOM_TIMEBOARD)
.shareType(DashboardShareType.OPEN)
.globalTime(
new DashboardGlobalTime().liveSpan(DashboardGlobalTimeLiveSpan.PAST_ONE_HOUR));
try {
SharedDashboard result = apiInstance.createPublicDashboard(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardsApi#createPublicDashboard");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Create a shared dashboard with a group template variable returns "OK" response
// Create a shared dashboard with a group template variable 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.DashboardGlobalTime;
import com.datadog.api.client.v1.model.DashboardGlobalTimeLiveSpan;
import com.datadog.api.client.v1.model.DashboardShareType;
import com.datadog.api.client.v1.model.DashboardType;
import com.datadog.api.client.v1.model.SelectableTemplateVariableItems;
import com.datadog.api.client.v1.model.SharedDashboard;
import java.util.Arrays;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
// there is a valid "dashboard" in the system
String DASHBOARD_ID = System.getenv("DASHBOARD_ID");
SharedDashboard body =
new SharedDashboard()
.dashboardId(DASHBOARD_ID)
.dashboardType(DashboardType.CUSTOM_TIMEBOARD)
.shareType(DashboardShareType.OPEN)
.globalTime(
new DashboardGlobalTime().liveSpan(DashboardGlobalTimeLiveSpan.PAST_ONE_HOUR))
.selectableTemplateVars(
Collections.singletonList(
new SelectableTemplateVariableItems()
.defaultValue("*")
.name("group_by_var")
.type("group")
.visibleTags(Arrays.asList("selectableValue1", "selectableValue2"))));
try {
SharedDashboard result = apiInstance.createPublicDashboard(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DashboardsApi#createPublicDashboard");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
Instructions
First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"Create a shared dashboard returns "OK" response
"""
Create a shared 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_global_time import DashboardGlobalTime
from datadog_api_client.v1.model.dashboard_global_time_live_span import DashboardGlobalTimeLiveSpan
from datadog_api_client.v1.model.dashboard_share_type import DashboardShareType
from datadog_api_client.v1.model.dashboard_type import DashboardType
from datadog_api_client.v1.model.shared_dashboard import SharedDashboard
# there is a valid "dashboard" in the system
DASHBOARD_ID = environ["DASHBOARD_ID"]
body = SharedDashboard(
dashboard_id=DASHBOARD_ID,
dashboard_type=DashboardType.CUSTOM_TIMEBOARD,
share_type=DashboardShareType.OPEN,
global_time=DashboardGlobalTime(
live_span=DashboardGlobalTimeLiveSpan.PAST_ONE_HOUR,
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
api_instance = DashboardsApi(api_client)
response = api_instance.create_public_dashboard(body=body)
print(response)
Create a shared dashboard with a group template variable returns "OK" response
"""
Create a shared dashboard with a group template variable 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_global_time import DashboardGlobalTime
from datadog_api_client.v1.model.dashboard_global_time_live_span import DashboardGlobalTimeLiveSpan
from datadog_api_client.v1.model.dashboard_share_type import DashboardShareType
from datadog_api_client.v1.model.dashboard_type import DashboardType
from datadog_api_client.v1.model.selectable_template_variable_items import SelectableTemplateVariableItems
from datadog_api_client.v1.model.shared_dashboard import SharedDashboard
# there is a valid "dashboard" in the system
DASHBOARD_ID = environ["DASHBOARD_ID"]
body = SharedDashboard(
dashboard_id=DASHBOARD_ID,
dashboard_type=DashboardType.CUSTOM_TIMEBOARD,
share_type=DashboardShareType.OPEN,
global_time=DashboardGlobalTime(
live_span=DashboardGlobalTimeLiveSpan.PAST_ONE_HOUR,
),
selectable_template_vars=[
SelectableTemplateVariableItems(
default_value="*",
name="group_by_var",
type="group",
visible_tags=[
"selectableValue1",
"selectableValue2",
],
),
],
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
api_instance = DashboardsApi(api_client)
response = api_instance.create_public_dashboard(body=body)
print(response)
Instructions
First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"Create a shared dashboard returns "OK" response
# Create a shared dashboard returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
# there is a valid "dashboard" in the system
DASHBOARD_ID = ENV["DASHBOARD_ID"]
body = DatadogAPIClient::V1::SharedDashboard.new({
dashboard_id: DASHBOARD_ID,
dashboard_type: DatadogAPIClient::V1::DashboardType::CUSTOM_TIMEBOARD,
share_type: DatadogAPIClient::V1::DashboardShareType::OPEN,
global_time: DatadogAPIClient::V1::DashboardGlobalTime.new({
live_span: DatadogAPIClient::V1::DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR,
}),
})
p api_instance.create_public_dashboard(body)
Create a shared dashboard with a group template variable returns "OK" response
# Create a shared dashboard with a group template variable returns "OK" response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V1::DashboardsAPI.new
# there is a valid "dashboard" in the system
DASHBOARD_ID = ENV["DASHBOARD_ID"]
body = DatadogAPIClient::V1::SharedDashboard.new({
dashboard_id: DASHBOARD_ID,
dashboard_type: DatadogAPIClient::V1::DashboardType::CUSTOM_TIMEBOARD,
share_type: DatadogAPIClient::V1::DashboardShareType::OPEN,
global_time: DatadogAPIClient::V1::DashboardGlobalTime.new({
live_span: DatadogAPIClient::V1::DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR,
}),
selectable_template_vars: [
DatadogAPIClient::V1::SelectableTemplateVariableItems.new({
default_value: "*",
name: "group_by_var",
type: "group",
visible_tags: [
"selectableValue1",
"selectableValue2",
],
}),
],
})
p api_instance.create_public_dashboard(body)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"Create a shared dashboard returns "OK" response
// Create a shared dashboard returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::model::DashboardGlobalTime;
use datadog_api_client::datadogV1::model::DashboardGlobalTimeLiveSpan;
use datadog_api_client::datadogV1::model::DashboardShareType;
use datadog_api_client::datadogV1::model::DashboardType;
use datadog_api_client::datadogV1::model::SharedDashboard;
#[tokio::main]
async fn main() {
// there is a valid "dashboard" in the system
let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
let body = SharedDashboard::new(dashboard_id.clone(), DashboardType::CUSTOM_TIMEBOARD)
.global_time(
DashboardGlobalTime::new().live_span(DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR),
)
.share_type(Some(DashboardShareType::OPEN));
let configuration = datadog::Configuration::new();
let api = DashboardsAPI::with_config(configuration);
let resp = api.create_public_dashboard(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Create a shared dashboard with a group template variable returns "OK" response
// Create a shared dashboard with a group template variable returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV1::api_dashboards::DashboardsAPI;
use datadog_api_client::datadogV1::model::DashboardGlobalTime;
use datadog_api_client::datadogV1::model::DashboardGlobalTimeLiveSpan;
use datadog_api_client::datadogV1::model::DashboardShareType;
use datadog_api_client::datadogV1::model::DashboardType;
use datadog_api_client::datadogV1::model::SelectableTemplateVariableItems;
use datadog_api_client::datadogV1::model::SharedDashboard;
#[tokio::main]
async fn main() {
// there is a valid "dashboard" in the system
let dashboard_id = std::env::var("DASHBOARD_ID").unwrap();
let body = SharedDashboard::new(dashboard_id.clone(), DashboardType::CUSTOM_TIMEBOARD)
.global_time(
DashboardGlobalTime::new().live_span(DashboardGlobalTimeLiveSpan::PAST_ONE_HOUR),
)
.selectable_template_vars(Some(vec![SelectableTemplateVariableItems::new()
.default_value("*".to_string())
.name("group_by_var".to_string())
.type_(Some("group".to_string()))
.visible_tags(Some(vec![
"selectableValue1".to_string(),
"selectableValue2".to_string(),
]))]))
.share_type(Some(DashboardShareType::OPEN));
let configuration = datadog::Configuration::new();
let api = DashboardsAPI::with_config(configuration);
let resp = api.create_public_dashboard(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
Instructions
First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE="datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runCreate a shared dashboard returns "OK" response
/**
* Create a shared dashboard returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
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.DashboardsApiCreatePublicDashboardRequest = {
body: {
dashboardId: DASHBOARD_ID,
dashboardType: "custom_timeboard",
shareType: "open",
globalTime: {
liveSpan: "1h",
},
},
};
apiInstance
.createPublicDashboard(params)
.then((data: v1.SharedDashboard) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Create a shared dashboard with a group template variable returns "OK" response
/**
* Create a shared dashboard with a group template variable returns "OK" response
*/
import { client, v1 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
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.DashboardsApiCreatePublicDashboardRequest = {
body: {
dashboardId: DASHBOARD_ID,
dashboardType: "custom_timeboard",
shareType: "open",
globalTime: {
liveSpan: "1h",
},
selectableTemplateVars: [
{
defaultValue: "*",
name: "group_by_var",
type: "group",
visibleTags: ["selectableValue1", "selectableValue2"],
},
],
},
};
apiInstance
.createPublicDashboard(params)
.then((data: v1.SharedDashboard) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
Instructions
First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"