REST Resource: projects.locations.instances.dashboards

Resource: Dashboard

Dashboard resource. NEXTAG: 7

JSON representation
{
  "name": string,
  "display_name": string,
  "uri": string,
  "default_dashboard": boolean,
  "type": enum (DashboardType),
  "lookml": string
}
Fields
name

string

Output only. The resource name of the dashboard. Format: projects/{project}/locations/{region}/instances/{instance}/dashboards/{dashboard}

display_name

string

User-visible dashboard name.

uri

string

Output only. The URI that displays the dashboard in the Chronicle UI. It may be empty.

default_dashboard

boolean

Whether the dashboard is displayed by default. Only one dashboard can be displayed by default.

type

enum (DashboardType)

Dashboard type.

lookml

string

The lookML model that defines the dashboard. When set in a create request, the dashboard defined by the lookML model is created. The lookML model must contain valid lookML YAML code. Suggest using the lookML format returned by the Chronicle's GetDashboard API or Looker GET lookml_models request as the input.

DashboardType

Types of dashboards.

Enums
DASHBOARD_TYPE_UNSPECIFIED Default value. This value is unused.
DASHBOARD_TYPE_PREDEFINED Read-only dashboard provided by Chronicle.
DASHBOARD_TYPE_USER Dashboard that only the user can see.
DASHBOARD_TYPE_CUSTOMER Dashboard that all the customer's users can see.

Methods

copy

Copy a dashboard of one type to a dashbooard of another type.

create

Create a dashboard.

delete

Delete a dashboard.

get

Get a dashboard.

list

List all dashboards.