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
+22-6Lines changed: 22 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -26248,7 +26248,7 @@ components:
26248
26248
- attributes
26249
26249
type: object
26250
26250
DashboardUsageAttributes:
26251
-
description: Usage statistics for a dashboard.
26251
+
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.
26252
26252
properties:
26253
26253
author:
26254
26254
$ref: "#/components/schemas/DashboardUsageUser"
@@ -26287,7 +26287,7 @@ components:
26287
26287
example: My production overview
26288
26288
type: string
26289
26289
total_views:
26290
-
description: The total number of times the dashboard has been viewed.
26290
+
description: Total view count for the dashboard. Counts only views captured by Real User Monitoring (RUM); `0` in orgs without RUM.
26291
26291
example: 42
26292
26292
format: int64
26293
26293
type: integer
@@ -26296,11 +26296,11 @@ components:
26296
26296
description: View count for that view type.
26297
26297
format: int64
26298
26298
type: integer
26299
-
description: View counts keyed by view type. Possible keys are `in_app`, `embed`, `public`, `shared`, `api`, and `unknown`.
26299
+
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.
26300
26300
nullable: true
26301
26301
type: object
26302
26302
viewed_at:
26303
-
description: When the dashboard was most recently viewed.
26303
+
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.
26304
26304
example: "2026-05-01T14:22:10.000Z"
26305
26305
format: date-time
26306
26306
nullable: true
@@ -115352,7 +115352,7 @@ paths:
115352
115352
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
115353
115353
/api/v2/dashboards/usage:
115354
115354
get:
115355
-
description: Get paginated usage statistics for every dashboard in the caller's organization. Use `page[limit]` and `page[offset]` to walk the result set.
115355
+
description: Get paginated usage statistics for every dashboard in the caller's organization. Use `page[limit]` and `page[offset]` to walk the result set. View-count fields depend on Real User Monitoring (RUM) and are `null` or `0` in orgs without RUM.
115356
115356
operationId: ListDashboardsUsage
115357
115357
parameters:
115358
115358
- description: Maximum number of dashboards to return per page. Server-side maximum is 500; values above 500 return a 400 Bad Request.
@@ -115372,6 +115372,22 @@ paths:
115372
115372
format: int64
115373
115373
minimum: 0
115374
115374
type: integer
115375
+
- description: Return only dashboards whose last edit (`edited_at`) is strictly before this timestamp (`edited_at < value`; boundary matches are excluded). Must be an ISO 8601 datetime with a timezone offset (for example, `Z` or `+00:00`); naive timestamps return HTTP 400.
115376
+
in: query
115377
+
name: filter[edited_before]
115378
+
required: false
115379
+
schema:
115380
+
example: "2025-04-26T00:00:00Z"
115381
+
format: date-time
115382
+
type: string
115383
+
- description: Return only dashboards whose most recent view (`viewed_at`) is strictly before this timestamp, including dashboards that have never been viewed. Must be an ISO 8601 datetime with a timezone offset; naive timestamps return HTTP 400. Orgs without Real User Monitoring (RUM) will see all dashboards returned by this filter.
115384
+
in: query
115385
+
name: filter[viewed_before]
115386
+
required: false
115387
+
schema:
115388
+
example: "2025-04-26T00:00:00Z"
115389
+
format: date-time
115390
+
type: string
115375
115391
responses:
115376
115392
"200":
115377
115393
content:
@@ -115453,7 +115469,7 @@ paths:
115453
115469
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
115454
115470
/api/v2/dashboards/{dashboard_id}/usage:
115455
115471
get:
115456
-
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.
115472
+
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.
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.
105
+
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.
Get paginated usage statistics for every dashboard in the caller's organization. Use ``page[limit]`` and ``page[offset]`` to walk the result set.
126
+
Get paginated usage statistics for every dashboard in the caller's organization. Use ``page[limit]`` and ``page[offset]`` to walk the result set. View-count fields depend on Real User Monitoring (RUM) and are ``null`` or ``0`` in orgs without RUM.
114
127
115
128
:param page_limit: Maximum number of dashboards to return per page. Server-side maximum is 500; values above 500 return a 400 Bad Request.
116
129
:type page_limit: int, optional
117
130
:param page_offset: Zero-based offset into the result set.
118
131
:type page_offset: int, optional
132
+
:param filter_edited_before: Return only dashboards whose last edit ( ``edited_at`` ) is strictly before this timestamp ( ``edited_at < value`` ; boundary matches are excluded). Must be an ISO 8601 datetime with a timezone offset (for example, ``Z`` or ``+00:00`` ); naive timestamps return HTTP 400.
133
+
:type filter_edited_before: datetime, optional
134
+
:param filter_viewed_before: Return only dashboards whose most recent view ( ``viewed_at`` ) is strictly before this timestamp, including dashboards that have never been viewed. Must be an ISO 8601 datetime with a timezone offset; naive timestamps return HTTP 400. Orgs without Real User Monitoring (RUM) will see all dashboards returned by this filter.
:param page_offset: Zero-based offset into the result set.
143
168
:type page_offset: int, optional
169
+
:param filter_edited_before: Return only dashboards whose last edit ( ``edited_at`` ) is strictly before this timestamp ( ``edited_at < value`` ; boundary matches are excluded). Must be an ISO 8601 datetime with a timezone offset (for example, ``Z`` or ``+00:00`` ); naive timestamps return HTTP 400.
170
+
:type filter_edited_before: datetime, optional
171
+
:param filter_viewed_before: Return only dashboards whose most recent view ( ``viewed_at`` ) is strictly before this timestamp, including dashboards that have never been viewed. Must be an ISO 8601 datetime with a timezone offset; naive timestamps return HTTP 400. Orgs without Real User Monitoring (RUM) will see all dashboards returned by this filter.
:param attributes: Usage statistics for a dashboard.
41
+
:param attributes: 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/datadog_api_client/v2/model/dashboard_usage_attributes.py
+4-4Lines changed: 4 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -74,7 +74,7 @@ def __init__(
74
74
**kwargs,
75
75
):
76
76
"""
77
-
Usage statistics for a dashboard.
77
+
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.
78
78
79
79
:param author: A user referenced from a dashboard usage record (author or viewer).
:param total_views: The total number of times the dashboard has been viewed.
100
+
:param total_views: Total view count for the dashboard. Counts only views captured by Real User Monitoring (RUM); ``0`` in orgs without RUM.
101
101
:type total_views: int, optional
102
102
103
-
:param total_views_by_type: View counts keyed by view type. Possible keys are ``in_app`` , ``embed`` , ``public`` , ``shared`` , ``api`` , and ``unknown``.
103
+
:param total_views_by_type: 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.
:param viewed_at: When the dashboard was most recently viewed.
106
+
:param viewed_at: When the dashboard was most recently viewed. Populated only when Real User Monitoring (RUM) is active for the org; ``null`` in orgs without RUM.
107
107
:type viewed_at: datetime, none_type, optional
108
108
109
109
:param viewer: A user referenced from a dashboard usage record (author or viewer).
0 commit comments