Class DashboardUsageAttributes

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.

Hierarchy

  • DashboardUsageAttributes

Constructors

constructor

Properties

additionalProperties? author? createdAt? dashboardQualityScore? editedAt? orgId teams? title? totalViews? totalViewsByType? viewedAt? viewer? widgetCount? widgetCountByType?

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional author

author?: DashboardUsageUser

A user referenced from a dashboard usage record (author or viewer).

Optional createdAt

createdAt?: Date

When the dashboard was created.

Optional dashboardQualityScore

dashboardQualityScore?: number

The dashboard quality score, or null when no score is available.

Optional editedAt

editedAt?: Date

When the dashboard was most recently edited.

orgId

orgId: number

The Datadog organization that owns the dashboard.

Optional teams

teams?: string[]

Teams the dashboard is tagged with.

Optional title

title?: string

The dashboard title.

Optional totalViews

totalViews?: number

Total view count for the dashboard. Counts only views captured by Real User Monitoring (RUM); 0 in orgs without RUM.

Optional totalViewsByType

totalViewsByType?: {
    [key: string]: number;
}

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.

Type declaration

  • [key: string]: number

Optional viewedAt

viewedAt?: Date

When the dashboard was most recently viewed. Populated only when Real User Monitoring (RUM) is active for the org; null in orgs without RUM.

Optional viewer

viewer?: DashboardUsageUser

A user referenced from a dashboard usage record (author or viewer).

Optional widgetCount

widgetCount?: number

The total number of widgets on the dashboard.

Optional widgetCountByType

widgetCountByType?: {
    [key: string]: number;
}

Widget counts keyed by widget type. The map includes group widgets and widgets without requests.

Type declaration

  • [key: string]: number

Settings

Member Visibility

Theme

Generated using TypeDoc