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
entityGrain: String
errors: [CustomDashboardPathError!]!
evaluatedAt: ISO8601DateTime!
groupsOverlap: Boolean!
interval: CustomDashboardInterval
measure: CustomDashboardMeasureDescriptor!
metricDescription: String
metricKey: String!
metricSemantics: String
metricVersion: Int!
notes: [String!]!
populationScope: String!
reasonCode: String
recordList: JSON
recordPage: CustomDashboardDrilldownRecords
revision: Int
rows: [CustomDashboardResultRow!]!
secondaryMeasure: CustomDashboardMeasureDescriptor
sourceEvidenceAt: ISO8601DateTime
sourceEvidenceState: String!
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.entityGrain ● String scalar​

Entity counted or measured by this metric; null for an invalid widget

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

CustomDashboardWidgetResult.evaluatedAt ● ISO8601DateTime! non-null scalar​

The single instant the request was evaluated at; this is query time, not source evidence time

CustomDashboardWidgetResult.groupsOverlap ● Boolean! non-null scalar​

Whether one entity may appear in more than one displayed group

CustomDashboardWidgetResult.interval ● CustomDashboardInterval object​

Null for a current-state metric

CustomDashboardWidgetResult.measure ● CustomDashboardMeasureDescriptor! non-null object​

CustomDashboardWidgetResult.metricDescription ● String scalar​

The registered metric's concise explanation

CustomDashboardWidgetResult.metricKey ● String! non-null scalar​

CustomDashboardWidgetResult.metricSemantics ● String scalar​

The registered metric definition for this version

CustomDashboardWidgetResult.metricVersion ● Int! non-null scalar​

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

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

CustomDashboardWidgetResult.populationScope ● String! non-null scalar​

CURRENT_VIEWER: every count, row and label uses the requesting viewer's current policy scope

CustomDashboardWidgetResult.reasonCode ● String scalar​

CustomDashboardWidgetResult.recordList ● JSON scalar​

Saved approved columns, sort and page size for a RECORD_LIST widget

CustomDashboardWidgetResult.recordPage ● CustomDashboardDrilldownRecords object​

First exact page of a RECORD_LIST widget; further pages use customDashboardDrilldown

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.sourceEvidenceAt ● ISO8601DateTime scalar​

Most recent category-specific successful synchronization among visible filtered assets, for scan-evidence metrics

CustomDashboardWidgetResult.sourceEvidenceState ● String! non-null scalar​

AVAILABLE, STALE_SUCCESSFUL_SYNC_EVIDENCE, NO_SUCCESSFUL_SYNC_EVIDENCE, NOT_APPLICABLE or UNAVAILABLE

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