Widget describe a widget component used to get statistics requests, based on parameters such as
dataType and widgetType. A widget can be a part of widgets collection inside a dashboard.
|
Cache
optional
|
map[String, array[String]]
|
Cache of join functions |
|
accounts
optional
|
map[String, Object]
|
Accounts list of accounts to query the widget data from |
|
cacheVersn
optional
|
Long
|
format: int64 |
|
category
optional
|
String
|
Category the widget is related to. Used to display in widget library under category or dataType if empty. |
|
commitMessage
optional
|
String
|
|
|
created
optional
|
Date
|
format: date-time |
|
dataType
optional
|
String
|
Data type of the widget. Describes what data does the widget query. supporting data types "incidents","messages","system","entries","tasks", "audit". |
|
dateRange
optional
|
DateRange | |
|
definition
optional
|
GenericObjectDefinition | |
|
definitionId
optional
|
String
|
|
|
description
optional
|
String
|
The description of the widget's usage and data representation. |
|
fromServerVersion
optional
|
Version | |
|
highlight
optional
|
map[String, array[String]]
|
|
|
id
optional
|
String
|
|
|
ignoreWorkers
optional
|
Boolean
|
Do not use workers mechanism while searching bleve |
|
indexName
optional
|
String
|
|
|
isPredefined
optional
|
Boolean
|
Is the widget a system widget. |
|
itemVersion
optional
|
Version | |
|
locked
optional
|
Boolean
|
Is the widget locked for editing. |
|
modified
optional
|
Date
|
format: date-time |
|
name
required
|
String
|
Default name of the widget. |
|
numericId
optional
|
Long
|
format: int64 |
|
packID
optional
|
String
|
|
|
packName
optional
|
String
|
|
|
packPropagationLabels
optional
|
array[String]
|
|
|
page
optional
|
Long
|
0-based page format: int64 |
|
params
optional
|
map[String, Object]
|
Additional parameters for this widget, depends on widget type and data. |
|
prevName
optional
|
String
|
The previous name of the widget. |
|
primaryTerm
optional
|
Long
|
format: int64 |
|
propagationLabels
optional
|
array[String]
|
|
|
query
optional
|
String
|
Query to search on the dataType. |
|
remote
optional
|
Boolean
|
|
|
searchAfter
optional
|
array[String]
|
Efficient next page, pass max sort value from previous page |
|
searchAfterElastic
optional
|
array[String]
|
Efficient next page, pass max ES sort value from previous page |
|
searchAfterMap
optional
|
map[String, array[String]]
|
Map accounts search after values - stores next page sort values per account. There is no need to store searchBeforeMap as [current page searchBefore] equals to [prev page searchAfter] More, there is no way to generate correct searchBefore from current page as some tenants may not appear at all. The map is relevant in proxy mode and used by tenants, each tenant extracts the searchAfter keys from the map. |
|
searchAfterMapOrder
optional
|
map[String, Long]
|
format: int64 |
|
searchBefore
optional
|
array[String]
|
Efficient prev page, pass min sort value from next page |
|
searchBeforeElastic
optional
|
array[String]
|
Efficient prev page, pass min ES sort value from next page |
|
sequenceNumber
optional
|
Long
|
format: int64 |
|
shouldCommit
optional
|
Boolean
|
|
|
size
optional
|
Long
|
Size is limited to 1000, if not passed it defaults to 0, and no results will return format: int64 |
|
sizeInBytes
optional
|
Long
|
format: int64 |
|
skipAggregateAccounts
optional
|
Boolean
|
SkipAggregateAccounts flag that indicates whether to skip aggregate accounts results |
|
sort
optional
|
array[Order] | The sort order |
|
sortValues
optional
|
array[String]
|
|
|
syncHash
optional
|
String
|
|
|
toServerVersion
optional
|
Version | |
|
vcShouldIgnore
optional
|
Boolean
|
|
|
vcShouldKeepItemLegacyProdMachine
optional
|
Boolean
|
|
|
version
optional
|
Long
|
format: int64 |
|
widgetType
required
|
String
|
Widget type describes how does the widget should recieve the data, and display it. Supporting types: "bar", "column", "pie", "list", "number", "trend", "text", "duration", "image", "line", and "table". |