Skip to content

Commit b56bacd

Browse files
Jiawen23claude
andauthored
Update Widget Share URLs docs (#37473)
* Update Widget Share URLs docs * Restore Datadog Clipboard distinction in Widget Share URLs note Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * Incorporate rtrieu and chatgpt-codex-connector's feedback --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent b859343 commit b56bacd

4 files changed

Lines changed: 28 additions & 21 deletions

File tree

config/_default/menus/main.en.yaml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1762,24 +1762,26 @@ menu:
17621762
url: dashboards/sharing/shared_dashboards
17631763
parent: dashboards_sharing
17641764
weight: 1002
1765-
- name: Widget Public URLs
1765+
- name: Widget Share URLs
17661766
identifier: dashboards_sharing_widget_public_urls
17671767
url: dashboards/sharing/widget_public_urls
1768+
parent: dashboards_sharing
1769+
weight: 1003
17681770
- name: Secure Embedded Dashboards
17691771
identifier: dashboards_sharing_secure_embedded_dashboards
17701772
url: dashboards/sharing/secure_embedded_dashboards
17711773
parent: dashboards_sharing
1772-
weight: 1003
1774+
weight: 1004
17731775
- name: Share Graphs
17741776
identifier: dashboards_sharing_graphs
17751777
url: dashboards/sharing/graphs
17761778
parent: dashboards_sharing
1777-
weight: 1004
1779+
weight: 1005
17781780
- name: Scheduled Reports
17791781
identifier: dashboards_reporting
17801782
url: dashboards/sharing/scheduled_reports
17811783
parent: dashboards_sharing
1782-
weight: 1005
1784+
weight: 1006
17831785
- name: Guides
17841786
url: dashboards/guide/
17851787
parent: dashboards

content/en/dashboards/sharing/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Shared visualizations allow you to display metric, trace, and log visualizations
2424
{{< whatsnext desc="How to share visualizations:" >}}
2525
{{< nextlink href="dashboards/sharing/shared_dashboards" >}}<strong>Shared dashboards</strong>: Generate a public link for users to access{{< /nextlink >}}
2626
{{< nextlink href="dashboards/sharing/graphs" >}}<strong>Share graphs</strong>: Generate an embed code{{< /nextlink >}}
27-
{{< nextlink href="dashboards/sharing/widget_public_urls" >}}<strong>Widget Public URLs</strong>: Copy widgets as images to share outside of Datadog{{< /nextlink >}}
27+
{{< nextlink href="dashboards/sharing/widget_public_urls" >}}<strong>Widget Share URLs</strong>: Copy widgets as images to share outside of Datadog{{< /nextlink >}}
2828
{{< nextlink href="dashboards/sharing/scheduled_reports" >}}<strong>Scheduled reports</strong>: Set a schedule to send email reports{{< /nextlink >}}
2929
{{< /whatsnext >}}
3030

content/en/dashboards/sharing/widget_public_urls.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Widget Public URLs
3-
description: Copy widgets as snapshot images and share them outside of Datadog.
2+
title: Widget Share URLs
3+
description: Copy widgets as images to share outside of Datadog.
44
further_reading:
55
- link: "/dashboards/sharing/"
66
tag: "Documentation"
@@ -12,27 +12,35 @@ further_reading:
1212

1313
## Overview
1414

15-
Widget Public URLs let you copy a dashboard widget as a static image and share it outside of Datadog. When you copy a widget with <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> + <kbd>C</kbd>, Datadog generates a publicly accessible link to a screenshot of the widget as it appears on your screen. This link is placed on your clipboard. When you paste outside of Datadog (for example, into Slack or Microsoft Teams) the link renders as a snapshot image of your widget.
15+
Widget Share URLs let you copy a dashboard widget as an image for use outside of Datadog. When you copy a widget with <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> + <kbd>C</kbd>, Datadog creates an image of the widget and generates a share URL. The URL behavior depends on your organization's Widget Share URLs setting.
1616

17-
**Note**: Widget Public URLs is separate from the [Datadog Clipboard][1], which copies widgets for use within Datadog (in dashboards, notebooks, and incidents). It is also unrelated to the [Snapshots API][2], which programmatically captures metric graph snapshots.
17+
Admins can choose how widget share links and previews work in [**Organization Settings > Public Sharing > Settings**][3]:
18+
19+
| Mode | Behavior |
20+
| --- | --- |
21+
| **Public** | Anyone with the share URL can view the widget image without a Datadog account. Third-party apps that support link previews, such as Slack or Microsoft Teams, can render a thumbnail of the widget. Viewing the source widget with live data still requires a Datadog account. |
22+
| **Private** | Share URLs are available only to authenticated users in the same Datadog organization. Public image URLs stop serving widget images, so third-party apps cannot render public image previews. Private preview unfurling is supported only in Slack, and only for Slack workspaces connected to the same Datadog organization. |
23+
| **Disabled** | Users cannot generate new Widget Share URLs. Existing share URLs and image endpoints are unavailable while the setting remains disabled, and Slack cannot generate new unfurls for those URLs. |
24+
25+
**Note**: Widget Share URLs is separate from the [Datadog Clipboard][1], which copies widgets for use within Datadog (in dashboards, notebooks, and incidents). It is also unrelated to the [Snapshots API][2], which programmatically captures metric graph snapshots.
1826

1927
## Prerequisites
2028

21-
This feature requires the **Widget Public URLs** setting to be enabled in your organization. To enable it, navigate to [**Organization Settings > Public Sharing > Settings**][3].
29+
This feature requires the **Widget Share URLs** setting to be set to **Public** or **Private** in your organization.
2230

23-
When enabled, copying a widget generates a publicly accessible snapshot image link. Anyone with the link can view the snapshot, regardless of whether they have a Datadog account.
31+
Admin changes to the Widget Share URLs mode apply immediately to existing share URLs.
2432

25-
## Copy a widget as an snapshot image
33+
## Copy a widget as a preview image
2634

2735
1. On any dashboard, hover over the widget you want to share.
2836
2. Press <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> + <kbd>C</kbd>, or click the share icon and select **Copy**.
2937
3. Paste outside of Datadog using <kbd>Cmd</kbd>/<kbd>Ctrl</kbd> + <kbd>V</kbd>.
3038

31-
In tools that support link previews (such as Slack or Microsoft Teams), the pasted link renders as a snapshot image of the widget.
39+
In tools that support link previews, the pasted link renders according to your organization's Widget Share URLs mode. In **Public** mode, the widget image is publicly accessible. In **Private** mode, public image previews are unavailable; Slack can render a private preview only when the Slack workspace is connected to the same Datadog organization.
3240

33-
## Disable Widget Public URLs
41+
## Disable Widget Share URLs
3442

35-
To stop generating publicly accessible widget image links, disable the **Widget Public URLs** setting in [**Organization Settings > Public Sharing > Settings**][3]. After disabling, copying a widget no longer generates a public snapshot image link. Previously generated links are no longer accessible.
43+
To stop users from generating widget share links and previews, disable the **Widget Share URLs** setting in [**Organization Settings > Public Sharing > Settings**][3]. After disabling, copying a widget no longer generates share links or previews, and previously shared URLs are no longer accessible. If the setting is later changed back to **Public** or **Private**, previously shared URLs resume functioning according to the selected mode.
3644

3745
## Further reading
3846

content/en/dashboards/widgets/configuration/_index.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Widgets not linked to global time show the data for their local time frame as ap
112112

113113
Copy and paste functionality is a key sharing and collaboration feature that allows you to reuse widgets across different Datadog contexts and external tools.
114114

115-
<div class="alert alert-danger">Enable <a href="https://app.datadoghq.com/organization-settings/public-sharing/settings"><strong>Static Public Data Sharing</strong></a> in your Organization Settings to use this feature.</div>
115+
<div class="alert alert-info">To share widgets outside of Datadog with link previews, an admin must set <a href="https://app.datadoghq.com/organization-settings/public-sharing/settings"><strong>Widget Share URLs</strong></a> to Public or Private in your Organization Settings. Admins can disable this setting to stop users from generating widget share links and previews.</div>
116116

117117
Widgets can be copied on [Dashboards][4], [Notebooks][5], [APM Service][6], and the [APM resource][7] page by using <kbd>Ctrl</kbd>/<kbd>Cmd</kbd> + <kbd>C</kbd>, or by selecting the share icon and choosing "Copy".
118118

@@ -121,9 +121,7 @@ The copied widgets can be pasted within Datadog by using <kbd>Ctrl</kbd>/<kbd>Cm
121121
* **Dashboards**: Adds a new widget positioned under your mouse cursor.
122122
* **Notebooks**: Adds a new cell at the end of the notebook.
123123

124-
You can also paste the widget into your favorite chat program that displays link previews (like Slack or Microsoft Teams). This displays a snapshot image of your graph along with a direct link to your widget. For more information, see [Widget Public URLs][11].
125-
126-
For information on copying widgets for use within Datadog (in dashboards, notebooks, and incidents), see [Datadog Clipboard][9].
124+
You can also paste the widget into your favorite chat program that displays link previews (like Slack or Microsoft Teams). Depending on your organization's Widget Share URLs mode, this displays a public preview image of your graph, or a private preview image in Slack, along with a direct link to your widget. For more information, see [Widget Share URLs][11].
127125

128126
## Groups of widgets
129127

@@ -200,6 +198,5 @@ Click on the context menu (three vertical dots) of any dashboard graph to open a
200198
[6]: /tracing/services/service_page/
201199
[7]: /tracing/services/resource_page/
202200
[8]: /dashboards/guide/custom_time_frames/
203-
[9]: /dashboards/guide/datadog_clipboard/
204201
[10]: /dashboards/widgets/split_graph/
205-
[11]: /dashboards/sharing/widget_public_urls/
202+
[11]: /dashboards/sharing/widget_public_urls/

0 commit comments

Comments
 (0)