Skip to main content

CustomDashboardWidgetResult

Standard result envelope for one widget; renderers never infer formulas from labels

type CustomDashboardWidgetResult {
  additive: Boolean!
  buckets: [CustomDashboardBucket!]!
  dimensions: [CustomDashboardDimensionDescriptor!]!
  drilldown: CustomDashboardDrilldown!
  drilldownContext: String
  effectiveFilters: JSON
  errors: [CustomDashboardPathError!]!
  evaluatedAt: ISO8601DateTime!
  interval: CustomDashboardInterval
  measure: CustomDashboardMeasureDescriptor!
  metricKey: String!
  metricVersion: Int!
  notes: [String!]!
  reasonCode: String
  revision: Int
  rows: [CustomDashboardResultRow!]!
  secondaryMeasure: CustomDashboardMeasureDescriptor
  state: CustomDashboardResultState!
  timeBasis: String!
  timezone: String!
  total: Float
  totalDenominator: Float
  totalNumerator: Float
  totalSampleSize: Int
  truncated: Boolean!
  unavailableReferences: [CustomDashboardUnavailableReference!]!
  widgetKey: String!
}

Fields​

CustomDashboardWidgetResult.additive ● Boolean! non-null scalar​

Rows of one bucket may be summed to the total

CustomDashboardWidgetResult.buckets ● [CustomDashboardBucket!]! non-null object​

CustomDashboardWidgetResult.dimensions ● [CustomDashboardDimensionDescriptor!]! non-null object​

CustomDashboardWidgetResult.drilldown ● CustomDashboardDrilldown! non-null object​

CustomDashboardWidgetResult.drilldownContext ● String scalar​

Opaque, short-lived reference to this saved widget's execution, for RECORDS drill-downs; null for a preview or a widget without record drill-down

CustomDashboardWidgetResult.effectiveFilters ● JSON scalar​

The constraint sets that were ANDed: dashboard (after runtime replacement) and widget

CustomDashboardWidgetResult.errors ● [CustomDashboardPathError!]! non-null object​

CustomDashboardWidgetResult.evaluatedAt ● ISO8601DateTime! non-null scalar​

The single instant the request was evaluated at; results are live, so this is also data freshness

CustomDashboardWidgetResult.interval ● CustomDashboardInterval object​

Null for a current-state metric

CustomDashboardWidgetResult.measure ● CustomDashboardMeasureDescriptor! non-null object​

CustomDashboardWidgetResult.metricKey ● String! non-null scalar​

CustomDashboardWidgetResult.metricVersion ● Int! non-null scalar​

CustomDashboardWidgetResult.notes ● [String!]! non-null scalar​

Machine codes qualifying the numbers, e.g. HISTORY_INCOMPLETE, CURRENT_CLASSIFICATION

CustomDashboardWidgetResult.reasonCode ● String scalar​

CustomDashboardWidgetResult.revision ● Int scalar​

Dashboard lockVersion executed; null for a preview

CustomDashboardWidgetResult.rows ● [CustomDashboardResultRow!]! non-null object​

CustomDashboardWidgetResult.secondaryMeasure ● CustomDashboardMeasureDescriptor object​

Measure of rows' secondaryValue

CustomDashboardWidgetResult.state ● CustomDashboardResultState! non-null enum​

CustomDashboardWidgetResult.timeBasis ● String! non-null scalar​

CustomDashboardWidgetResult.timezone ● String! non-null scalar​

CustomDashboardWidgetResult.total ● Float scalar​

Whole-population value (distinct count, mean or rate), never a sum of overlapping groups

CustomDashboardWidgetResult.totalDenominator ● Float scalar​

CustomDashboardWidgetResult.totalNumerator ● Float scalar​

CustomDashboardWidgetResult.totalSampleSize ● Int scalar​

CustomDashboardWidgetResult.truncated ● Boolean! non-null scalar​

More groups exist than the widget's limit

CustomDashboardWidgetResult.unavailableReferences ● [CustomDashboardUnavailableReference!]! non-null object​

CustomDashboardWidgetResult.widgetKey ● String! non-null scalar​

Returned By​

executeCustomDashboard query ● previewCustomDashboardWidget query

Contribute to the Docs

Found something outdated or missing? Help us improve the documentation with a quick suggestion or edit.

How to contribute

Resources

By exploring our content, you'll find resources that will enhance your understanding of the importance of a Security Application Program.

Conviso Blog: Explore our blog, which offers a collection of articles and posts covering a wide range of AppSec topics. The content on the blog is primarily in English.

Conviso's YouTube Channel: Access a wealth of informative videos covering various topics related to AppSec. Please note that the content is primarily in Portuguese.