Skip to content

Commit 88a4ee3

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 1532499 of spec repo
1 parent 5d69285 commit 88a4ee3

30 files changed

Lines changed: 2417 additions & 0 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 359 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22950,6 +22950,136 @@ components:
2295022950
- INTEGRATION_SCREENBOARD
2295122951
- INTEGRATION_TIMEBOARD
2295222952
- HOST_TIMEBOARD
22953+
DashboardUsage:
22954+
description: A single dashboard usage record.
22955+
properties:
22956+
attributes:
22957+
$ref: "#/components/schemas/DashboardUsageAttributes"
22958+
id:
22959+
description: The dashboard ID.
22960+
example: "q5j-nti-fv6"
22961+
type: string
22962+
type:
22963+
$ref: "#/components/schemas/DashboardUsageType"
22964+
required:
22965+
- id
22966+
- type
22967+
- attributes
22968+
type: object
22969+
DashboardUsageAttributes:
22970+
description: Usage statistics for a dashboard.
22971+
properties:
22972+
author:
22973+
$ref: "#/components/schemas/DashboardUsageUser"
22974+
created_at:
22975+
description: When the dashboard was created.
22976+
example: "2026-01-15T09:30:00.000Z"
22977+
format: date-time
22978+
nullable: true
22979+
type: string
22980+
dashboard_quality_score:
22981+
description: The dashboard quality score, or `null` when no score is available.
22982+
example: 0.85
22983+
format: double
22984+
nullable: true
22985+
type: number
22986+
edited_at:
22987+
description: When the dashboard was most recently edited.
22988+
example: "2026-04-20T11:05:00.000Z"
22989+
format: date-time
22990+
nullable: true
22991+
type: string
22992+
org_id:
22993+
description: The Datadog organization that owns the dashboard.
22994+
example: 100
22995+
format: int64
22996+
type: integer
22997+
teams:
22998+
description: Teams the dashboard is tagged with.
22999+
items:
23000+
description: A team handle.
23001+
type: string
23002+
nullable: true
23003+
type: array
23004+
title:
23005+
description: The dashboard title.
23006+
example: My production overview
23007+
type: string
23008+
total_views:
23009+
description: The total number of times the dashboard has been viewed.
23010+
example: 42
23011+
format: int64
23012+
type: integer
23013+
total_views_by_type:
23014+
additionalProperties:
23015+
description: View count for that view type.
23016+
format: int64
23017+
type: integer
23018+
description: View counts keyed by view type. Possible keys are `in_app`, `embed`, `public`, `shared`, `api`, and `unknown`.
23019+
nullable: true
23020+
type: object
23021+
viewed_at:
23022+
description: When the dashboard was most recently viewed.
23023+
example: "2026-05-01T14:22:10.000Z"
23024+
format: date-time
23025+
nullable: true
23026+
type: string
23027+
viewer:
23028+
$ref: "#/components/schemas/DashboardUsageUser"
23029+
widget_count:
23030+
description: The total number of widgets on the dashboard.
23031+
example: 12
23032+
format: int64
23033+
nullable: true
23034+
type: integer
23035+
widget_count_by_type:
23036+
additionalProperties:
23037+
description: Widget count for that widget type.
23038+
format: int64
23039+
type: integer
23040+
description: Widget counts keyed by widget type. The map includes group widgets and widgets without requests.
23041+
nullable: true
23042+
type: object
23043+
required:
23044+
- org_id
23045+
type: object
23046+
DashboardUsageResponse:
23047+
description: Response containing usage statistics for a single dashboard.
23048+
properties:
23049+
data:
23050+
$ref: "#/components/schemas/DashboardUsage"
23051+
required:
23052+
- data
23053+
type: object
23054+
DashboardUsageType:
23055+
default: dashboards-usages
23056+
description: The type of the resource. Always `dashboards-usages`.
23057+
enum:
23058+
- dashboards-usages
23059+
example: dashboards-usages
23060+
type: string
23061+
x-enum-varnames:
23062+
- DASHBOARDS_USAGES
23063+
DashboardUsageUser:
23064+
description: A user referenced from a dashboard usage record (author or viewer).
23065+
nullable: true
23066+
properties:
23067+
handle:
23068+
description: Datadog handle (login) of the user.
23069+
example: jane.doe@example.com
23070+
type: string
23071+
id:
23072+
description: The user ID.
23073+
example: "00000000-0000-0000-0000-000000000000"
23074+
type: string
23075+
is_disabled:
23076+
description: Whether the user account is disabled.
23077+
type: boolean
23078+
name:
23079+
description: Display name of the user.
23080+
example: Jane Doe
23081+
type: string
23082+
type: object
2295323083
DataAttributesRulesItemsIfTagExists:
2295423084
description: The behavior when the tag already exists.
2295523085
enum:
@@ -43097,6 +43227,52 @@ components:
4309743227
type: string
4309843228
x-enum-varnames:
4309943229
- LIST_CONNECTIONS_RESPONSE
43230+
ListDashboardsUsageResponse:
43231+
description: Paginated list of dashboard usage records.
43232+
properties:
43233+
data:
43234+
description: Dashboard usage records, one per dashboard in the caller's organization.
43235+
items:
43236+
$ref: "#/components/schemas/DashboardUsage"
43237+
type: array
43238+
links:
43239+
$ref: "#/components/schemas/ListDashboardsUsageResponseLinks"
43240+
meta:
43241+
$ref: "#/components/schemas/ListDashboardsUsageResponseMeta"
43242+
required:
43243+
- data
43244+
- meta
43245+
type: object
43246+
ListDashboardsUsageResponseLinks:
43247+
description: Pagination links for a list of dashboard usage records.
43248+
properties:
43249+
first:
43250+
description: Link to the first page.
43251+
example: "https://api.datadoghq.com/api/v2/dashboards/usage?page[offset]=0&page[limit]=250"
43252+
type: string
43253+
last:
43254+
description: Link to the last page, or `null` if the total is unknown.
43255+
nullable: true
43256+
type: string
43257+
next:
43258+
description: Link to the next page. Absent when there is no next page.
43259+
nullable: true
43260+
type: string
43261+
prev:
43262+
description: Link to the previous page. Absent when there is no previous page.
43263+
nullable: true
43264+
type: string
43265+
self:
43266+
description: Link to the current page.
43267+
example: "https://api.datadoghq.com/api/v2/dashboards/usage"
43268+
type: string
43269+
type: object
43270+
ListDashboardsUsageResponseMeta:
43271+
description: Pagination metadata for a list of dashboard usage records.
43272+
properties:
43273+
page:
43274+
$ref: "#/components/schemas/PaginationMetaPage"
43275+
type: object
4310043276
ListDeploymentRuleResponseData:
4310143277
description: Data for a list of deployment rules.
4310243278
properties:
@@ -102327,6 +102503,183 @@ paths:
102327102503
x-unstable: |-
102328102504
**Note**: This endpoint is in preview and is subject to change.
102329102505
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
102506+
/api/v2/dashboards/usage:
102507+
get:
102508+
description: Get paginated usage statistics for every dashboard in the caller's organization. Use `page[limit]` and `page[offset]` to walk the result set.
102509+
operationId: ListDashboardsUsage
102510+
parameters:
102511+
- description: Maximum number of dashboards to return per page.
102512+
in: query
102513+
name: page[limit]
102514+
required: false
102515+
schema:
102516+
default: 250
102517+
format: int64
102518+
maximum: 500
102519+
minimum: 1
102520+
type: integer
102521+
- description: Zero-based offset into the result set.
102522+
in: query
102523+
name: page[offset]
102524+
required: false
102525+
schema:
102526+
default: 0
102527+
format: int64
102528+
minimum: 0
102529+
type: integer
102530+
responses:
102531+
"200":
102532+
content:
102533+
application/json:
102534+
examples:
102535+
default:
102536+
value:
102537+
data:
102538+
- attributes:
102539+
author:
102540+
handle: "jane.doe@example.com"
102541+
id: "00000000-0000-0000-0000-000000000000"
102542+
is_disabled: false
102543+
name: "Jane Doe"
102544+
created_at: "2026-01-15T09:30:00.000Z"
102545+
dashboard_quality_score: 0.85
102546+
edited_at: "2026-04-20T11:05:00.000Z"
102547+
org_id: 100
102548+
teams: ["sre"]
102549+
title: "My production overview"
102550+
total_views: 42
102551+
total_views_by_type:
102552+
embed: 12
102553+
in_app: 30
102554+
viewed_at: "2026-05-01T14:22:10.000Z"
102555+
viewer:
102556+
handle: "john.smith@example.com"
102557+
id: "00000000-0000-0000-0000-000000000001"
102558+
is_disabled: false
102559+
name: "John Smith"
102560+
widget_count: 12
102561+
widget_count_by_type:
102562+
query_value: 4
102563+
timeseries: 8
102564+
id: "q5j-nti-fv6"
102565+
type: "dashboards-usages"
102566+
links:
102567+
first: "https://api.datadoghq.com/api/v2/dashboards/usage?page[offset]=0&page[limit]=250"
102568+
last: "https://api.datadoghq.com/api/v2/dashboards/usage?page[offset]=1000&page[limit]=250"
102569+
next: "https://api.datadoghq.com/api/v2/dashboards/usage?page[offset]=250&page[limit]=250"
102570+
self: "https://api.datadoghq.com/api/v2/dashboards/usage"
102571+
meta:
102572+
page:
102573+
first_offset: 0
102574+
last_offset: 1000
102575+
limit: 250
102576+
next_offset: 250
102577+
offset: 0
102578+
prev_offset:
102579+
total: 1234
102580+
type: offset_limit
102581+
schema:
102582+
$ref: "#/components/schemas/ListDashboardsUsageResponse"
102583+
description: OK
102584+
"400":
102585+
$ref: "#/components/responses/BadRequestResponse"
102586+
"403":
102587+
$ref: "#/components/responses/ForbiddenResponse"
102588+
"429":
102589+
$ref: "#/components/responses/TooManyRequestsResponse"
102590+
security:
102591+
- apiKeyAuth: []
102592+
appKeyAuth: []
102593+
- AuthZ:
102594+
- dashboards_read
102595+
summary: Get usage stats for all dashboards
102596+
tags:
102597+
- Dashboards
102598+
x-pagination:
102599+
limitParam: page[limit]
102600+
pageOffsetParam: page[offset]
102601+
resultsPath: data
102602+
x-permission:
102603+
operator: OR
102604+
permissions:
102605+
- dashboards_read
102606+
x-unstable: |-
102607+
**Note**: This endpoint is in preview and is subject to change.
102608+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
102609+
/api/v2/dashboards/{dashboard_id}/usage:
102610+
get:
102611+
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.
102612+
operationId: GetDashboardUsage
102613+
parameters:
102614+
- description: The ID of the dashboard.
102615+
in: path
102616+
name: dashboard_id
102617+
required: true
102618+
schema:
102619+
example: "q5j-nti-fv6"
102620+
type: string
102621+
responses:
102622+
"200":
102623+
content:
102624+
application/json:
102625+
examples:
102626+
default:
102627+
value:
102628+
data:
102629+
attributes:
102630+
author:
102631+
handle: "jane.doe"
102632+
id: "00000000-0000-0000-0000-000000000000"
102633+
is_disabled: false
102634+
name: "Jane Doe"
102635+
created_at: "2026-01-15T09:30:00.000Z"
102636+
dashboard_quality_score: 0.85
102637+
edited_at: "2026-04-20T11:05:00.000Z"
102638+
org_id: 100
102639+
teams: ["sre"]
102640+
title: "My production overview"
102641+
total_views: 42
102642+
total_views_by_type:
102643+
embed: 12
102644+
in_app: 30
102645+
viewed_at: "2026-05-01T14:22:10.000Z"
102646+
viewer:
102647+
handle: "john.smith"
102648+
id: "00000000-0000-0000-0000-000000000001"
102649+
is_disabled: false
102650+
name: "John Smith"
102651+
widget_count: 12
102652+
widget_count_by_type:
102653+
query_value: 4
102654+
timeseries: 8
102655+
id: "q5j-nti-fv6"
102656+
type: "dashboards-usages"
102657+
schema:
102658+
$ref: "#/components/schemas/DashboardUsageResponse"
102659+
description: OK
102660+
"400":
102661+
$ref: "#/components/responses/BadRequestResponse"
102662+
"403":
102663+
$ref: "#/components/responses/ForbiddenResponse"
102664+
"404":
102665+
$ref: "#/components/responses/NotFoundResponse"
102666+
"429":
102667+
$ref: "#/components/responses/TooManyRequestsResponse"
102668+
security:
102669+
- apiKeyAuth: []
102670+
appKeyAuth: []
102671+
- AuthZ:
102672+
- dashboards_read
102673+
summary: Get usage stats for a dashboard
102674+
tags:
102675+
- Dashboards
102676+
x-permission:
102677+
operator: OR
102678+
permissions:
102679+
- dashboards_read
102680+
x-unstable: |-
102681+
**Note**: This endpoint is in preview and is subject to change.
102682+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
102330102683
/api/v2/datasets:
102331102684
get:
102332102685
description: Get all datasets that have been configured for an organization.
@@ -150986,6 +151339,12 @@ tags:
150986151339
- **Embed** sharing must be enabled under **Organization Settings** > **Public Sharing** > **Shared Dashboards**.
150987151340
- You need [an API key and an application key](https://docs.datadoghq.com/account_management/api-app-keys/) to interact with these endpoints.
150988151341
name: Dashboard Secure Embed
151342+
- description: |-
151343+
Get usage statistics for the dashboards in your organization, including view
151344+
counts, last-edit times, widget counts, and quality scores. See the
151345+
[Dashboards documentation](https://docs.datadoghq.com/dashboards/) for more
151346+
information.
151347+
name: Dashboards
150989151348
- description: |-
150990151349
The Data Deletion API allows the user to target and delete data from the allowed products. It's currently enabled for Logs and RUM and depends on `logs_delete_data` and `rum_delete_data` permissions respectively.
150991151350
name: Data Deletion

0 commit comments

Comments
 (0)