Resource: NativeDashboard
NativeDashboard resource. NEXT TAG: 13
JSON representation |
---|
{ "name": string, "displayName": string, "description": string, "definition": { object ( |
Fields | |
---|---|
name |
Output only. Name of the dashboard. |
displayName |
Required. Dashboard display name/title visible to users. |
description |
Optional. Description of the dashboard. |
definition |
Optional. Definition of the dashboard like metadata, visualization and datasource configuration etc. |
type |
Output only. Whether it's an out of the box or custom created dashboard. |
createTime |
Output only. Creation time of dashboard. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
updateTime |
Output only. Time the dashboard was last edited. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
createUserId |
Output only. User who created the dashboard. |
updateUserId |
Output only. User who last edited the dashboard. |
dashboardUserData |
Output only. User Preferences for a dashboard |
etag |
Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. |
access |
Output only. Access of the dashboard |
DashboardDefinition
Definition of the dashboard including filters, layout, charts' configurations.
JSON representation |
---|
{ "filters": [ { object ( |
Fields | |
---|---|
filters[] |
Filters for the dashboard. |
fingerprint |
Fingerprint of the dashboard definition. |
charts[] |
Charts in the dashboard. |
DashboardFilter
Dashboard level filter that can be used in native dashboards as well as inputs to execute query.
JSON representation |
---|
{ "id": string, "dataSource": enum ( |
Fields | |
---|---|
id |
ID of the filter. |
dataSource |
Datasource the filter is applicable for. |
fieldPath |
Filter field path. |
filterOperatorAndFieldValues[] |
Operator and values. Can include multiple modifiers. |
displayName |
Display name of the filter. |
chartIds[] |
Chart IDs the filter is applicable for. |
isStandardTimeRangeFilter |
Optional. Whether the filter is a standard time range filter, meaning that it has to be used as the query time range, and not as a predicate in the query. A chart can have at most one standard time range filter applied. |
isMandatory |
Optional. Whether this filter is required to be populated by the dashboard consumer prior to the dashboard loading. |
isStandardTimeRangeFilterEnabled |
Optional. Whether this standard time range filter is enabled. |
ChartConfig
Configuration of the chart including chart reference, layout and filters.
JSON representation |
---|
{
"dashboardChart": string,
"chartLayout": {
object ( |
Fields | |
---|---|
dashboardChart |
|
chartLayout |
|
filtersIds[] |
Dashboard filters applied to the chart. |
ChartLayout
Layout of the chart.
JSON representation |
---|
{ "spanX": integer, "spanY": integer, "startX": integer, "startY": integer } |
Fields | |
---|---|
spanX |
|
spanY |
|
startX |
|
startY |
|
DashboardType
Type of the dashboard.
Enums | |
---|---|
DASHBOARD_TYPE_UNSPECIFIED |
Default unspecified. |
CURATED |
Out of the box curated dashboards provided by Chronicle. |
PRIVATE |
Private dashboards created by users/customers. |
PUBLIC |
Public dashboards created by users/customers. |
CUSTOM |
Custom dashboards |
MARKETPLACE |
Marketplace dashboards |
DashboardUserData
User Data for Native Dashboard
JSON representation |
---|
{ "lastViewedTime": string, "isPinned": boolean } |
Fields | |
---|---|
lastViewedTime |
time when this dashboard is last viewed Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
isPinned |
is dashboard pinned by user |
DashboardAccess
AccessType of the dashboard.
Enums | |
---|---|
DASHBOARD_ACCESS_UNSPECIFIED |
Default unspecified. |
DASHBOARD_PRIVATE |
Private dashboards created by users/customers. |
DASHBOARD_PUBLIC |
Public dashboards created by users/customers. |
Methods |
|
---|---|
|
Add chart in a dashboard. |
|
Create a dashboard. |
|
Delete a dashboard. |
|
Duplicate a dashboard. |
|
Duplicate chart in a dashboard. |
|
Edit chart in a dashboard. |
|
Exports the dashboards. |
|
Get a dashboard. |
|
Imports the dashboards. |
|
List all dashboards. |
|
Update a dashboard. |
|
Remove chart from a dashboard. |