Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1451,6 +1451,8 @@ components:
description: Description of the dashboard.
nullable: true
type: string
experience_type:
$ref: "#/components/schemas/DashboardExperienceType"
id:
description: ID of the dashboard.
example: "123-abc-456"
Expand Down Expand Up @@ -1573,6 +1575,17 @@ components:
description: ID of the deleted dashboard.
type: string
type: object
DashboardExperienceType:
description: The experience type of the dashboard.
enum:
- default
- product_analytics
example: default
readOnly: true
type: string
x-enum-varnames:
- DEFAULT
- PRODUCT_ANALYTICS
DashboardFixedTimeframe:
description: A fixed dashboard timeframe.
properties:
Expand Down
14 changes: 7 additions & 7 deletions features/generated-test/test-server-data/v1/dashboards.json
Original file line number Diff line number Diff line change
Expand Up @@ -11619,15 +11619,15 @@
},
{
"feature": "Dashboards",
"frozen_at": "2024-11-15T19:33:06.052Z",
"frozen_at": "2026-10-01T01:04:23.267Z",
"interactions": [
{
"request": {
"body": {
"type": "json",
"value": {
"layout_type": "ordered",
"title": "Test-Get_a_dashboard_returns_OK_response-1731699186 with Profile Metrics Query",
"title": "Test-Get_a_dashboard_returns_OK_response-1790816663 with Profile Metrics Query",
"widgets": [
{
"definition": {
Expand Down Expand Up @@ -11669,7 +11669,7 @@
"response": {
"body": {
"encoding": "text",
"value": "{\"id\":\"448-ktj-ezs\",\"title\":\"Test-Get_a_dashboard_returns_OK_response-1731699186 with Profile Metrics Query\",\"description\":null,\"author_handle\":\"frog@datadoghq.com\",\"author_name\":null,\"layout_type\":\"ordered\",\"url\":\"/dashboard/448-ktj-ezs/test-getadashboardreturnsokresponse-1731699186-with-profile-metrics-query\",\"is_read_only\":false,\"template_variables\":null,\"widgets\":[{\"definition\":{\"requests\":[{\"profile_metrics_query\":{\"compute\":{\"aggregation\":\"sum\",\"facet\":\"@prof_core_cpu_cores\"},\"group_by\":[{\"facet\":\"service\",\"limit\":10,\"sort\":{\"aggregation\":\"sum\",\"facet\":\"@prof_core_cpu_cores\",\"order\":\"desc\"}}],\"search\":{\"query\":\"runtime:jvm\"}}}],\"type\":\"timeseries\"},\"id\":7381515167611300}],\"notify_list\":null,\"created_at\":\"2024-11-15T19:33:06.217022+00:00\",\"modified_at\":\"2024-11-15T19:33:06.217022+00:00\",\"restricted_roles\":[]}\n"
"value": "{\"id\":\"223-fhs-m3a\",\"title\":\"Test-Get_a_dashboard_returns_OK_response-1790816663 with Profile Metrics Query\",\"description\":null,\"author_handle\":\"frog@datadoghq.com\",\"author_name\":\"frog\",\"layout_type\":\"ordered\",\"url\":\"/dashboard/223-fhs-m3a/test-getadashboardreturnsokresponse-1790816663-with-profile-metrics-query\",\"template_variables\":null,\"widgets\":[{\"definition\":{\"requests\":[{\"profile_metrics_query\":{\"compute\":{\"aggregation\":\"sum\",\"facet\":\"@prof_core_cpu_cores\"},\"group_by\":[{\"facet\":\"service\",\"limit\":10,\"sort\":{\"aggregation\":\"sum\",\"facet\":\"@prof_core_cpu_cores\",\"order\":\"desc\"}}],\"search\":{\"query\":\"runtime:jvm\"}}}],\"type\":\"timeseries\"},\"id\":737698456766602}],\"notify_list\":null,\"created_at\":\"2026-10-01T01:04:23.449294+00:00\",\"modified_at\":\"2026-10-01T01:04:23.449294+00:00\",\"experience_type\":\"default\",\"restricted_roles\":[]}"
},
"headers": {
"content-type": "application/json"
Expand All @@ -11686,13 +11686,13 @@
},
"content_type": "",
"method": "GET",
"path": "/api/v1/dashboard/448-ktj-ezs",
"path": "/api/v1/dashboard/223-fhs-m3a",
"query": []
},
"response": {
"body": {
"encoding": "text",
"value": "{\"id\":\"448-ktj-ezs\",\"title\":\"Test-Get_a_dashboard_returns_OK_response-1731699186 with Profile Metrics Query\",\"description\":null,\"author_handle\":\"frog@datadoghq.com\",\"author_name\":null,\"layout_type\":\"ordered\",\"url\":\"/dashboard/448-ktj-ezs/test-getadashboardreturnsokresponse-1731699186-with-profile-metrics-query\",\"is_read_only\":false,\"template_variables\":null,\"widgets\":[{\"definition\":{\"requests\":[{\"profile_metrics_query\":{\"compute\":{\"aggregation\":\"sum\",\"facet\":\"@prof_core_cpu_cores\"},\"group_by\":[{\"facet\":\"service\",\"limit\":10,\"sort\":{\"aggregation\":\"sum\",\"facet\":\"@prof_core_cpu_cores\",\"order\":\"desc\"}}],\"search\":{\"query\":\"runtime:jvm\"}}}],\"type\":\"timeseries\"},\"id\":7381515167611300}],\"notify_list\":null,\"created_at\":\"2024-11-15T19:33:06.217022+00:00\",\"modified_at\":\"2024-11-15T19:33:06.217022+00:00\",\"restricted_roles\":[]}\n"
"value": "{\"id\":\"223-fhs-m3a\",\"title\":\"Test-Get_a_dashboard_returns_OK_response-1790816663 with Profile Metrics Query\",\"description\":null,\"author_handle\":\"frog@datadoghq.com\",\"author_name\":\"frog\",\"layout_type\":\"ordered\",\"url\":\"/dashboard/223-fhs-m3a/test-getadashboardreturnsokresponse-1790816663-with-profile-metrics-query\",\"template_variables\":null,\"widgets\":[{\"definition\":{\"requests\":[{\"profile_metrics_query\":{\"compute\":{\"aggregation\":\"sum\",\"facet\":\"@prof_core_cpu_cores\"},\"group_by\":[{\"facet\":\"service\",\"limit\":10,\"sort\":{\"aggregation\":\"sum\",\"facet\":\"@prof_core_cpu_cores\",\"order\":\"desc\"}}],\"search\":{\"query\":\"runtime:jvm\"}}}],\"type\":\"timeseries\"},\"id\":737698456766602}],\"notify_list\":null,\"created_at\":\"2026-10-01T01:04:23.449294+00:00\",\"modified_at\":\"2026-10-01T01:04:23.449294+00:00\",\"experience_type\":\"default\",\"restricted_roles\":[]}"
},
"headers": {
"content-type": "application/json"
Expand All @@ -11709,13 +11709,13 @@
},
"content_type": "",
"method": "DELETE",
"path": "/api/v1/dashboard/448-ktj-ezs",
"path": "/api/v1/dashboard/223-fhs-m3a",
"query": []
},
"response": {
"body": {
"encoding": "text",
"value": "{\"deleted_dashboard_id\":\"448-ktj-ezs\"}\n"
"value": "{\"deleted_dashboard_id\":\"223-fhs-m3a\"}"
},
"headers": {
"content-type": "application/json"
Expand Down
1 change: 1 addition & 0 deletions features/v1/dashboards.feature
Original file line number Diff line number Diff line change
Expand Up @@ -1348,6 +1348,7 @@ Feature: Dashboards
When the request is sent
Then the response status is 200 OK
And the response "description" is equal to null
And the response "experience_type" is equal to "default"

@replay-only @team:DataDog/dashboards-backend
Scenario: Get a dashboard returns 'author_name'
Expand Down
1 change: 1 addition & 0 deletions packages/datadog-api-client-v1/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -412,6 +412,7 @@ export { DashboardBulkActionData } from "./models/DashboardBulkActionData";
export { DashboardBulkDeleteRequest } from "./models/DashboardBulkDeleteRequest";
export { DashboardDefaultTimeframeSetting } from "./models/DashboardDefaultTimeframeSetting";
export { DashboardDeleteResponse } from "./models/DashboardDeleteResponse";
export { DashboardExperienceType } from "./models/DashboardExperienceType";
export { DashboardFixedTimeframe } from "./models/DashboardFixedTimeframe";
export { DashboardFixedTimeframeType } from "./models/DashboardFixedTimeframeType";
export { DashboardGlobalTime } from "./models/DashboardGlobalTime";
Expand Down
9 changes: 9 additions & 0 deletions packages/datadog-api-client-v1/models/Dashboard.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* Copyright 2020-Present Datadog, Inc.
*/
import { DashboardDefaultTimeframeSetting } from "./DashboardDefaultTimeframeSetting";
import { DashboardExperienceType } from "./DashboardExperienceType";
import { DashboardLayoutType } from "./DashboardLayoutType";
import { DashboardReflowType } from "./DashboardReflowType";
import { DashboardTab } from "./DashboardTab";
Expand Down Expand Up @@ -38,6 +39,10 @@ export class Dashboard {
* Description of the dashboard.
*/
"description"?: string;
/**
* The experience type of the dashboard.
*/
"experienceType"?: DashboardExperienceType;
/**
* ID of the dashboard.
*/
Expand Down Expand Up @@ -136,6 +141,10 @@ export class Dashboard {
baseName: "description",
type: "string",
},
experienceType: {
baseName: "experience_type",
type: "DashboardExperienceType",
},
id: {
baseName: "id",
type: "string",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/**
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
* This product includes software developed at Datadog (https://www.datadoghq.com/).
* Copyright 2020-Present Datadog, Inc.
*/

import { UnparsedObject } from "../../datadog-api-client-common/util";

/**
* The experience type of the dashboard.
*/

export type DashboardExperienceType =
| typeof DEFAULT
| typeof PRODUCT_ANALYTICS
| UnparsedObject;
export const DEFAULT = "default";
export const PRODUCT_ANALYTICS = "product_analytics";
Original file line number Diff line number Diff line change
Expand Up @@ -843,6 +843,7 @@ const enumsMap: { [key: string]: any[] } = {
"previous_month",
],
ContentEncoding: ["gzip", "deflate"],
DashboardExperienceType: ["default", "product_analytics"],
DashboardFixedTimeframeType: ["fixed"],
DashboardGlobalTimeLiveSpan: [
"15m",
Expand Down
Loading