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.
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.
104
+
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.
125
+
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.
114
126
115
127
: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
128
:type page_limit: int, optional
117
129
:param page_offset: Zero-based offset into the result set.
118
130
:type page_offset: int, optional
131
+
:param filter_edited_before: 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.
132
+
:type filter_edited_before: str, optional
133
+
:param filter_viewed_before: 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.
:param page_offset: Zero-based offset into the result set.
143
167
:type page_offset: int, optional
168
+
:param filter_edited_before: 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.
169
+
:type filter_edited_before: str, optional
170
+
:param filter_viewed_before: 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.
: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