REST Resource: projects.locations.instances.dashboards

Resource: Dashboard

Dashboard resource.

JSON representation 
{
  "name": string,
  "displayName": string,
  "uri": string,
  "defaultDashboard": boolean,
  "type": enum (DashboardType),
  "lookml": string,
  "migrationInfo": {
    object (DashboardMigrationInfo)
  },
  "readOnly": boolean
}
Fields
name

string

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

string

User-visible dashboard name.
uri

string

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

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 dashboards.get API or Looker GET lookml_models request as the input.
migrationInfo

object (DashboardMigrationInfo)

Output only. Migration details for this dashboard. Only set on dashboards that are eligible for migration to a native dashboard.
readOnly

boolean

Output only. Whether this dashboard is read only. A read only dashboard cannot be updated or deleted.

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.

DashboardMigrationInfo

Migration details for a legacy dashboard. Only set on dashboards that are eligible for migration to a native dashboard.

JSON representation 
{
  "migrationJobId": string,
  "state": enum (DashboardMigrationState),
  "nativeDashboard": string
}
Fields
migrationJobId

string

Output only. The ID of the migration job that created this dashboard entry.
state

enum (DashboardMigrationState)

Output only. The state of this dashboard's migration.
nativeDashboard

string

Output only. The resource name of the native dashboard this dashboard was migrated into. Only set when state is DASHBOARD_MIGRATION_STATE_SUCCESS.

DashboardMigrationState

State of the dashboard migration.

Enums
DASHBOARD_MIGRATION_STATE_UNSPECIFIED Default value. This value is unused.
DASHBOARD_MIGRATION_STATE_PENDING The migration is pending.
DASHBOARD_MIGRATION_STATE_IN_PROGRESS The migration is in progress.
DASHBOARD_MIGRATION_STATE_SUCCESS The migration was successful.
DASHBOARD_MIGRATION_STATE_NEEDS_REVIEW The migration needs review.
DASHBOARD_MIGRATION_STATE_FAILED The migration failed.

Methods

batchMigrate

 Batch migrate legacy dashboards to native dashboards.

copy

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

create

 Create a dashboard.

delete

 Delete a dashboard.

fetchMigratable

 List of all legacy dashboards that can be migrated to native dashboards.

fetchMigrationJobs

 Fetch migration jobs for a given customer.

fetchMigrationMetrics

 Fetch metrics related to the dashboard migrations e.g.

get

 Get a dashboard.

list

 List all dashboards.