Class: DatadogAPIClient::V2::DashboardUsageAttributes

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/dashboard_usage_attributes.rb

Overview

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.

Instance Attribute Summary collapse

Method Summary

Methods included from BaseGenericModel

included

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



76
77
78
 
# File 'lib/datadog_api_client/v2/models/dashboard_usage_attributes.rb', line 76

def additional_properties
  @additional_properties
end

#author ⇒ Object

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



25
26
27
 
# File 'lib/datadog_api_client/v2/models/dashboard_usage_attributes.rb', line 25

def author
  @author
end

#created_at ⇒ Object

When the dashboard was created.



28
29
30
 
# File 'lib/datadog_api_client/v2/models/dashboard_usage_attributes.rb', line 28

def created_at
  @created_at
end

#dashboard_quality_score ⇒ Object

The dashboard quality score ranges from 0 to 1, with higher scores indicating stronger signals of quality and usefulness. The value is null when no score is available.

The score considers the following factors:

  • Dashboard and widget naming, including whether the dashboard uses a default or templated name
  • The number of data widgets, excluding container and text widgets
  • Confirmed broken queries
  • Recent activity, based on the last view date or, when no view date is available, the last edit or creation date

Dashboards linked from monitors do not receive lower scores because of their naming or lack of recent activity. An age-based adjustment helps prevent newly created dashboards from receiving disproportionately low scores. Queries lower the score only when confirmed broken.



44
45
46
 
# File 'lib/datadog_api_client/v2/models/dashboard_usage_attributes.rb', line 44

def dashboard_quality_score
  @dashboard_quality_score
end

#edited_at ⇒ Object

When the dashboard was most recently edited.



47
48
49
 
# File 'lib/datadog_api_client/v2/models/dashboard_usage_attributes.rb', line 47

def edited_at
  @edited_at
end

#org_id ⇒ Object

The Datadog organization that owns the dashboard.



50
51
52
 
# File 'lib/datadog_api_client/v2/models/dashboard_usage_attributes.rb', line 50

def org_id
  @org_id
end

#teams ⇒ Object

Teams the dashboard is tagged with.



53
54
55
 
# File 'lib/datadog_api_client/v2/models/dashboard_usage_attributes.rb', line 53

def teams
  @teams
end

#title ⇒ Object

The dashboard title.



56
57
58
 
# File 'lib/datadog_api_client/v2/models/dashboard_usage_attributes.rb', line 56

def title
  @title
end

#total_views ⇒ Object

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



59
60
61
 
# File 'lib/datadog_api_client/v2/models/dashboard_usage_attributes.rb', line 59

def total_views
  @total_views
end

#total_views_by_type ⇒ Object

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.



62
63
64
 
# File 'lib/datadog_api_client/v2/models/dashboard_usage_attributes.rb', line 62

def total_views_by_type
  @total_views_by_type
end

#viewed_at ⇒ Object

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



65
66
67
 
# File 'lib/datadog_api_client/v2/models/dashboard_usage_attributes.rb', line 65

def viewed_at
  @viewed_at
end

#viewer ⇒ Object

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



68
69
70
 
# File 'lib/datadog_api_client/v2/models/dashboard_usage_attributes.rb', line 68

def viewer
  @viewer
end

#widget_count ⇒ Object

The total number of widgets on the dashboard.



71
72
73
 
# File 'lib/datadog_api_client/v2/models/dashboard_usage_attributes.rb', line 71

def widget_count
  @widget_count
end

#widget_count_by_type ⇒ Object

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



74
75
76
 
# File 'lib/datadog_api_client/v2/models/dashboard_usage_attributes.rb', line 74

def widget_count_by_type
  @widget_count_by_type
end