REST Resource: projects.locations.instances.nativeDashboards

Resource: NativeDashboard

NativeDashboard resource.

JSON representation 
{
  "name": string,
  "display_name": string,
  "description": string,
  "definition": {
    object (DashboardDefinition)
  },
  "type": enum (DashboardType),
  "create_time": string,
  "update_time": string,
  "create_user_id": string,
  "update_user_id": string,
  "dashboard_user_data": {
    object (DashboardUserData)
  },
  "etag": string,
  "access": enum (DashboardAccess)
}
Fields
name

string

Output only. Name of the dashboard.
display_name

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.
create_time

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
update_time

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
create_user_id

string

Output only. User who created the dashboard.
update_user_id

string

Output only. User who last edited the dashboard.
dashboard_user_data

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,
  "data_source": enum (DataSource),
  "field_path": string,
  "filter_operator_and_field_values": [
    {
      object (FilterOperatorAndValues)
    }
  ],
  "display_name": string,
  "chart_ids": [
    string
  ],
  "is_standard_time_range_filter": boolean,
  "is_mandatory": boolean,
  "is_standard_time_range_filter_enabled": boolean
}
Fields
id

string

ID of the filter.
data_source

enum (DataSource)

Datasource the filter is applicable for.
field_path

string

Filter field path.
filter_operator_and_field_values[]

object (FilterOperatorAndValues)

Operator and values. Can include multiple modifiers.
display_name

string

Display name of the filter.
chart_ids[]

string

Chart IDs the filter is applicable for.
is_standard_time_range_filter

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.
is_mandatory

boolean

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

boolean

Optional. Whether this standard time range filter is enabled.

ChartConfig

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

JSON representation 
{
  "dashboard_chart": string,
  "chart_layout": {
    object (ChartLayout)
  },
  "filters_ids": [
    string
  ]
}
Fields
dashboard_chart

string
chart_layout

object (ChartLayout)
filters_ids[]

string

Dashboard filters applied to the chart.

ChartLayout

Layout of the chart.

JSON representation 
{
  "span_x": integer,
  "span_y": integer,
  "start_x": integer,
  "start_y": integer
}
Fields
span_x

integer
span_y

integer
start_x

integer
start_y

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 
{
  "last_viewed_time": string,
  "is_pinned": boolean
}
Fields
last_viewed_time

string (Timestamp format)

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: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
is_pinned

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.

get

 Get a dashboard.

list

 List all dashboards.

patch

 Update a dashboard.

removeChart

 Remove chart from a dashboard.