REST Resource: projects.locations.instances.nativeDashboards

Resource: NativeDashboard

NativeDashboard resource.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "definition": {
    object (DashboardDefinition)
  },
  "type": enum (DashboardType),
  "createTime": string,
  "updateTime": string,
  "createUserId": string,
  "updateUserId": string,
  "dashboardUserData": {
    object (DashboardUserData)
  },
  "etag": string,
  "access": enum (DashboardAccess)
}
Fields
name

string

Output only. Name of the dashboard.
displayName

string

Required. Dashboard display name/title visible to users.
description

string

Optional. Description of the dashboard.
definition

object (DashboardDefinition)

Optional. Definition of the dashboard like metadata, visualization and datasource configuration etc.
type

enum (DashboardType)

Output only. Whether it's an out of the box or custom created dashboard.
createTime

string (Timestamp format)

Output only. Creation time of dashboard.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Time the dashboard was last edited.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
createUserId

string

Output only. User who created the dashboard.
updateUserId

string

Output only. User who last edited the dashboard.
dashboardUserData

object (DashboardUserData)

Output only. User Preferences for a dashboard
etag

string

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

enum (DashboardAccess)

Output only. Access of the dashboard

DashboardDefinition

Definition of the dashboard including filters, layout, charts' configurations.

JSON representation 
{
  "filters": [
    {
      object (DashboardFilter)
    }
  ],
  "fingerprint": string,
  "charts": [
    {
      object (ChartConfig)
    }
  ]
}
Fields
filters[]

object (DashboardFilter)

Filters for the dashboard.
fingerprint

string

Fingerprint of the dashboard definition.
charts[]

object (ChartConfig)

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 (DataSource),
  "fieldPath": string,
  "filterOperatorAndFieldValues": [
    {
      object (FilterOperatorAndValues)
    }
  ],
  "displayName": string,
  "chartIds": [
    string
  ],
  "isStandardTimeRangeFilter": boolean,
  "isMandatory": boolean,
  "advancedFilterConfig": {
    object (AdvancedFilterConfig)
  },
  "isStandardTimeRangeFilterEnabled": boolean
}
Fields
id

string

ID of the filter.
dataSource

enum (DataSource)

Datasource the filter is applicable for.
fieldPath

string

Filter field path.
filterOperatorAndFieldValues[]

object (FilterOperatorAndValues)

Operator and values. Can include multiple modifiers.
displayName

string

Display name of the filter.
chartIds[]

string

Chart IDs the filter is applicable for.
isStandardTimeRangeFilter

boolean

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

boolean

Optional. Whether this filter is required to be populated by the dashboard consumer prior to the dashboard loading.
advancedFilterConfig

object (AdvancedFilterConfig)

Optional. Advanced filter configuration for the filter widget.
isStandardTimeRangeFilterEnabled

boolean

Optional. Whether this standard time range filter is enabled.

AdvancedFilterConfig

Advanced filter configuration for the filter widget.

JSON representation 
{
  "token": string,
  "prefix": string,
  "suffix": string,
  "separator": string,
  "multipleAllowed": boolean,
  "defaultValues": [
    string
  ],
  "skipDefaultAffixes": boolean,
  "valueSource": {
    object (ValueSource)
  }
}
Fields
token

string

Required. The token name to look for in the query (e.g., "hostname"). The system will automatically wrap this in '$' (e.g., "$hostname$").
prefix

string

Optional. String to prepend to the final replaced value (e.g., "/", "^(", """).
suffix

string

Optional. String to append to the final replaced value (e.g., "/", ")$", """).
separator

string

Optional. Delimiter to join multiple selected values (e.g., "|", " OR field = ").
multipleAllowed

boolean

Optional. Whether to allow selection of multiple values.
defaultValues[]

string

Optional. Default values to use if no value is selected/provided.
skipDefaultAffixes

boolean

Optional. Whether to skip the configured prefix and suffix when using default values. If true, default values are inserted raw (joined by the separator).
valueSource

object (ValueSource)

Required. Source of the values for the filter.

ValueSource

Source of the values for the filter.

JSON representation 
{

  // Union field source can be only one of the following:
  "manualOptions": {
    object (ManualOptions)
  },
  "queryOptions": {
    object (QueryOptions)
  }
  // End of list of possible types for union field source.
}
Fields
Union field source. Source of the values for the filter. source can be only one of the following:
manualOptions

object (ManualOptions)

Optional. Manual options provided by the user.
queryOptions

object (QueryOptions)

Optional. Query options to fetch the values from the query engine. This is used for the filter's population query.

ManualOptions

Manual options provided by the user.

JSON representation 
{
  "options": [
    string
  ]
}
Fields
options[]

string

Optional. The options provided by the user. The max number of options is limited to 10000.

QueryOptions

Query options to fetch the values from the query engine. This is used for the filter's population query.

JSON representation 
{
  "query": string,
  "column": string,
  "globalTimeFilterEnabled": boolean,
  "input": {
    object (Input)
  }
}
Fields
query

string

Required. The query to execute to fetch the values.
column

string

Required. The column name to use for the values.
globalTimeFilterEnabled

boolean

Optional. Enable global time filter
input

object (Input)

Optional. Time range input specifically for the filter's population query.

ChartConfig

Configuration of the chart including chart reference, layout and filters.

JSON representation 
{
  "dashboardChart": string,
  "chartLayout": {
    object (ChartLayout)
  },
  "filtersIds": [
    string
  ]
}
Fields
dashboardChart

string
chartLayout

object (ChartLayout)
filtersIds[]

string

Dashboard filters applied to the chart.

ChartLayout

Layout of the chart.

JSON representation 
{
  "spanX": integer,
  "spanY": integer,
  "startX": integer,
  "startY": integer
}
Fields
spanX

integer
spanY

integer
startX

integer
startY

integer

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

string (Timestamp format)

time when this dashboard is last viewed

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
isPinned

boolean

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

addChart

 Add chart in a dashboard.

create

 Create a dashboard.

delete

 Delete a dashboard.

duplicate

 Duplicate a dashboard.

duplicateChart

 Duplicate chart in a dashboard.

editChart

 Edit chart in a dashboard.

export

 Exports the dashboards.

get

 Get a dashboard.

import

 Imports the dashboards.

list

 List all dashboards.

patch

 Update a dashboard.

removeChart

 Remove chart from a dashboard.