You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .generator/schemas/v2/openapi.yaml
+20-6Lines changed: 20 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -27293,7 +27293,7 @@ components:
27293
27293
- attributes
27294
27294
type: object
27295
27295
DashboardUsageAttributes:
27296
-
description: Usage statistics for a dashboard.
27296
+
description: Usage statistics for a dashboard. The `viewer` field and all view-count fields (`total_views`, `viewed_at`, `total_views_by_type`) are populated only when Real User Monitoring (RUM) is active for the org.
27297
27297
properties:
27298
27298
author:
27299
27299
$ref: "#/components/schemas/DashboardUsageUser"
@@ -27332,7 +27332,7 @@ components:
27332
27332
example: My production overview
27333
27333
type: string
27334
27334
total_views:
27335
-
description: The total number of times the dashboard has been viewed.
27335
+
description: Total view count for the dashboard. Counts only views captured by Real User Monitoring (RUM); `0` in orgs without RUM.
27336
27336
example: 42
27337
27337
format: int64
27338
27338
type: integer
@@ -27341,11 +27341,11 @@ components:
27341
27341
description: View count for that view type.
27342
27342
format: int64
27343
27343
type: integer
27344
-
description: View counts keyed by view type. Possible keys are `in_app`, `embed`, `public`, `shared`, `api`, and `unknown`.
27344
+
description: View counts keyed by view type (`in_app`, `embed`, `public`, `shared`, `api`, `unknown`). Counts only views captured by Real User Monitoring (RUM); empty in orgs without RUM.
27345
27345
nullable: true
27346
27346
type: object
27347
27347
viewed_at:
27348
-
description: When the dashboard was most recently viewed.
27348
+
description: When the dashboard was most recently viewed. Populated only when Real User Monitoring (RUM) is active for the org; `null` in orgs without RUM.
27349
27349
example: "2026-05-01T14:22:10.000Z"
27350
27350
format: date-time
27351
27351
nullable: true
@@ -117452,7 +117452,7 @@ paths:
117452
117452
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
117453
117453
/api/v2/dashboards/usage:
117454
117454
get:
117455
-
description: Get paginated usage statistics for every dashboard in the caller's organization. Use `page[limit]` and `page[offset]` to walk the result set.
117455
+
description: Get paginated usage statistics for every dashboard in the caller's organization. Use `page[limit]` and `page[offset]` to walk the result set. Use `filter[edited_before]` or `filter[viewed_before]` to narrow results by recency. View-count fields depend on Real User Monitoring (RUM) and are `null` or `0` in orgs without RUM.
117456
117456
operationId: ListDashboardsUsage
117457
117457
parameters:
117458
117458
- description: Maximum number of dashboards to return per page. Server-side maximum is 500; values above 500 return a 400 Bad Request.
@@ -117472,6 +117472,20 @@ paths:
117472
117472
format: int64
117473
117473
minimum: 0
117474
117474
type: integer
117475
+
- description: Return only dashboards whose last edit (`edited_at`) is strictly before this ISO 8601 timestamp (`edited_at < value`; boundary matches are excluded). Must include a timezone offset (for example, `Z` or `+00:00`); naive timestamps return HTTP 400.
117476
+
in: query
117477
+
name: filter[edited_before]
117478
+
required: false
117479
+
schema:
117480
+
example: "2025-04-26T00:00:00Z"
117481
+
type: string
117482
+
- description: Return only dashboards whose most recent view (`viewed_at`) is strictly before this ISO 8601 timestamp, including dashboards that have never been viewed. Must include a timezone offset; naive timestamps return HTTP 400. Orgs without Real User Monitoring (RUM) will see all dashboards returned by this filter.
117483
+
in: query
117484
+
name: filter[viewed_before]
117485
+
required: false
117486
+
schema:
117487
+
example: "2025-04-26T00:00:00Z"
117488
+
type: string
117475
117489
responses:
117476
117490
"200":
117477
117491
content:
@@ -117553,7 +117567,7 @@ paths:
117553
117567
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
117554
117568
/api/v2/dashboards/{dashboard_id}/usage:
117555
117569
get:
117556
-
description: Get usage statistics for a single dashboard. The response includes view counts, the most recent view and edit times, widget counts, and the dashboard quality score.
117570
+
description: Get usage statistics for a single dashboard. The response includes view counts, the most recent view and edit times, widget counts, and the dashboard quality score. View-count fields depend on Real User Monitoring (RUM) and are `null` or `0` in orgs without RUM.
/// Return only dashboards whose last edit (`edited_at`) is strictly before this ISO 8601 timestamp (`edited_at < value`; boundary matches are excluded). Must include a timezone offset (for example, `Z` or `+00:00`); naive timestamps return HTTP 400.
20
+
pubfilter_edited_before:Option<String>,
21
+
/// Return only dashboards whose most recent view (`viewed_at`) is strictly before this ISO 8601 timestamp, including dashboards that have never been viewed. Must include a timezone offset; naive timestamps return HTTP 400. Orgs without Real User Monitoring (RUM) will see all dashboards returned by this filter.
/// Return only dashboards whose last edit (`edited_at`) is strictly before this ISO 8601 timestamp (`edited_at < value`; boundary matches are excluded). Must include a timezone offset (for example, `Z` or `+00:00`); naive timestamps return HTTP 400.
/// Return only dashboards whose most recent view (`viewed_at`) is strictly before this ISO 8601 timestamp, including dashboards that have never been viewed. Must include a timezone offset; naive timestamps return HTTP 400. Orgs without Real User Monitoring (RUM) will see all dashboards returned by this filter.
/// GetDashboardUsageError is a struct for typed errors of method [`DashboardsAPI::get_dashboard_usage`]
@@ -124,7 +138,7 @@ impl DashboardsAPI {
124
138
Self{ config, client }
125
139
}
126
140
127
-
/// Get usage statistics for a single dashboard. The response includes view counts, the most recent view and edit times, widget counts, and the dashboard quality score.
141
+
/// Get usage statistics for a single dashboard. The response includes view counts, the most recent view and edit times, widget counts, and the dashboard quality score. View-count fields depend on Real User Monitoring (RUM) and are `null` or `0` in orgs without RUM.
128
142
pubasyncfnget_dashboard_usage(
129
143
&self,
130
144
dashboard_id:String,
@@ -146,7 +160,7 @@ impl DashboardsAPI {
146
160
}
147
161
}
148
162
149
-
/// Get usage statistics for a single dashboard. The response includes view counts, the most recent view and edit times, widget counts, and the dashboard quality score.
163
+
/// Get usage statistics for a single dashboard. The response includes view counts, the most recent view and edit times, widget counts, and the dashboard quality score. View-count fields depend on Real User Monitoring (RUM) and are `null` or `0` in orgs without RUM.
150
164
pubasyncfnget_dashboard_usage_with_http_info(
151
165
&self,
152
166
dashboard_id:String,
@@ -241,7 +255,7 @@ impl DashboardsAPI {
241
255
}
242
256
}
243
257
244
-
/// Get paginated usage statistics for every dashboard in the caller's organization. Use `page[limit]` and `page[offset]` to walk the result set.
258
+
/// Get paginated usage statistics for every dashboard in the caller's organization. Use `page[limit]` and `page[offset]` to walk the result set. Use `filter[edited_before]` or `filter[viewed_before]` to narrow results by recency. View-count fields depend on Real User Monitoring (RUM) and are `null` or `0` in orgs without RUM.
245
259
pubasyncfnlist_dashboards_usage(
246
260
&self,
247
261
params:ListDashboardsUsageOptionalParams,
@@ -299,7 +313,7 @@ impl DashboardsAPI {
299
313
}
300
314
}
301
315
302
-
/// Get paginated usage statistics for every dashboard in the caller's organization. Use `page[limit]` and `page[offset]` to walk the result set.
316
+
/// Get paginated usage statistics for every dashboard in the caller's organization. Use `page[limit]` and `page[offset]` to walk the result set. Use `filter[edited_before]` or `filter[viewed_before]` to narrow results by recency. View-count fields depend on Real User Monitoring (RUM) and are `null` or `0` in orgs without RUM.
303
317
pubasyncfnlist_dashboards_usage_with_http_info(
304
318
&self,
305
319
params:ListDashboardsUsageOptionalParams,
@@ -321,6 +335,8 @@ impl DashboardsAPI {
321
335
// unbox and build optional parameters
322
336
let page_limit = params.page_limit;
323
337
let page_offset = params.page_offset;
338
+
let filter_edited_before = params.filter_edited_before;
339
+
let filter_viewed_before = params.filter_viewed_before;
Copy file name to clipboardExpand all lines: src/datadogV2/model/model_dashboard_usage.rs
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ use std::fmt::{self, Formatter};
11
11
#[skip_serializing_none]
12
12
#[derive(Clone,Debug,PartialEq,Serialize)]
13
13
pubstructDashboardUsage{
14
-
/// Usage statistics for a dashboard.
14
+
/// Usage statistics for a dashboard. The `viewer` field and all view-count fields (`total_views`, `viewed_at`, `total_views_by_type`) are populated only when Real User Monitoring (RUM) is active for the org.
Copy file name to clipboardExpand all lines: src/datadogV2/model/model_dashboard_usage_attributes.rs
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ use serde::{Deserialize, Deserializer, Serialize};
6
6
use serde_with::skip_serializing_none;
7
7
use std::fmt::{self,Formatter};
8
8
9
-
/// Usage statistics for a dashboard.
9
+
/// Usage statistics for a dashboard. The `viewer` field and all view-count fields (`total_views`, `viewed_at`, `total_views_by_type`) are populated only when Real User Monitoring (RUM) is active for the org.
/// The total number of times the dashboard has been viewed.
47
+
/// Total view count for the dashboard. Counts only views captured by Real User Monitoring (RUM); `0` in orgs without RUM.
48
48
#[serde(rename = "total_views")]
49
49
pubtotal_views:Option<i64>,
50
-
/// View counts keyed by view type. Possible keys are `in_app`, `embed`, `public`, `shared`, `api`, and `unknown`.
50
+
/// View counts keyed by view type (`in_app`, `embed`, `public`, `shared`, `api`, `unknown`). Counts only views captured by Real User Monitoring (RUM); empty in orgs without RUM.
Copy file name to clipboardExpand all lines: tests/scenarios/cassettes/v2/dashboards/Get-usage-stats-for-all-dashboards-with-both-filters-returns-OK-response.json
0 commit comments