dashboards

Creates, updates, deletes, gets or lists a dashboards resource.

Overview

Name	dashboards
Type	Resource
Id	google.contactcenterinsights.dashboards

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}
createTime	string (google-datetime)	Output only. Dashboard creation time.
dateRangeConfig	object	Date range config applied to all charts in the dashboard. (id: GoogleCloudContactcenterinsightsV1DateRangeConfig)
description	string	Dashboard description
displayName	string	User provided display name of the dashboard.
filter	string	Filter applied to all charts in the dashboard. Should support scope later.
readOnly	boolean	Output only. Whether the dashboard is read-only. All predefined dashboards are read-only and cannot be modified by the user.
rootContainer	object	The dashboard's root widget container. We want to display the dashboard layout in a tree-like structure, where the root container contains other widgets (containers or charts) as children. (id: GoogleCloudContactcenterinsightsV1Container)
updateTime	string (google-datetime)	Output only. Dashboard last update time.

list

Name	Datatype	Description
name	string	Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}
createTime	string (google-datetime)	Output only. Dashboard creation time.
dateRangeConfig	object	Date range config applied to all charts in the dashboard. (id: GoogleCloudContactcenterinsightsV1DateRangeConfig)
description	string	Dashboard description
displayName	string	User provided display name of the dashboard.
filter	string	Filter applied to all charts in the dashboard. Should support scope later.
readOnly	boolean	Output only. Whether the dashboard is read-only. All predefined dashboards are read-only and cannot be modified by the user.
rootContainer	object	The dashboard's root widget container. We want to display the dashboard layout in a tree-like structure, where the root container contains other widgets (containers or charts) as children. (id: GoogleCloudContactcenterinsightsV1Container)
updateTime	string (google-datetime)	Output only. Dashboard last update time.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, dashboardsId		Gets a Dashboard.
list	select	projectsId, locationsId	pageSize, filter, pageToken, orderBy	Lists Dashboards.
create	insert	projectsId, locationsId	dashboardId	Creates a Dashboard.
patch	update	projectsId, locationsId, dashboardsId	updateMask	Updates a Dashboard.
delete	delete	projectsId, locationsId, dashboardsId		Deletes a Dashboard.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dashboardsId	string
locationsId	string
projectsId	string
dashboardId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets a Dashboard.

SELECT
name,
createTime,
dateRangeConfig,
description,
displayName,
filter,
readOnly,
rootContainer,
updateTime
FROM google.contactcenterinsights.dashboards
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dashboardsId = '{{ dashboardsId }}' -- required
;

list

Lists Dashboards.

SELECT
name,
createTime,
dateRangeConfig,
description,
displayName,
filter,
readOnly,
rootContainer,
updateTime
FROM google.contactcenterinsights.dashboards
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
;

INSERT examples

create

Creates a Dashboard.

INSERT INTO google.contactcenterinsights.dashboards (
data__dateRangeConfig,
data__name,
data__filter,
data__displayName,
data__rootContainer,
data__description,
projectsId,
locationsId,
dashboardId
)
SELECT 
'{{ dateRangeConfig }}',
'{{ name }}',
'{{ filter }}',
'{{ displayName }}',
'{{ rootContainer }}',
'{{ description }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ dashboardId }}'
RETURNING
name,
createTime,
dateRangeConfig,
description,
displayName,
filter,
readOnly,
rootContainer,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: dashboards
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the dashboards resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the dashboards resource.
  - name: dateRangeConfig
    description: |
      Date range config applied to all charts in the dashboard.
    value:
      absoluteDateRange:
        startTime: "{{ startTime }}"
        endTime: "{{ endTime }}"
      relativeDateRange:
        quantity: "{{ quantity }}"
        unit: "{{ unit }}"
  - name: name
    value: "{{ name }}"
    description: |
      Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}
  - name: filter
    value: "{{ filter }}"
    description: |
      Filter applied to all charts in the dashboard. Should support scope later.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      User provided display name of the dashboard.
  - name: rootContainer
    description: |
      The dashboard's root widget container. We want to display the dashboard layout in a tree-like structure, where the root container contains other widgets (containers or charts) as children.
    value:
      displayName: "{{ displayName }}"
      height: {{ height }}
      filter: "{{ filter }}"
      widgets:
        - container:
            displayName: "{{ displayName }}"
            height: {{ height }}
            filter: "{{ filter }}"
            widgets:
              - container:
                  displayName: "{{ displayName }}"
                  height: {{ height }}
                  filter: "{{ filter }}"
                  widgets: "{{ widgets }}"
                  description: "{{ description }}"
                  width: {{ width }}
                  containerId: "{{ containerId }}"
                  dateRangeConfig: "{{ dateRangeConfig }}"
                filter: "{{ filter }}"
                chart:
                  description: "{{ description }}"
                  height: {{ height }}
                  chartType: "{{ chartType }}"
                  createTime: "{{ createTime }}"
                  updateTime: "{{ updateTime }}"
                  action: "{{ action }}"
                  width: {{ width }}
                  dataSource: "{{ dataSource }}"
                  filter: "{{ filter }}"
                  name: "{{ name }}"
                  dateRangeConfig: "{{ dateRangeConfig }}"
                  displayName: "{{ displayName }}"
                  chartVisualizationType: "{{ chartVisualizationType }}"
                chartReference: "{{ chartReference }}"
            description: "{{ description }}"
            width: {{ width }}
            containerId: "{{ containerId }}"
            dateRangeConfig:
              absoluteDateRange:
                startTime: "{{ startTime }}"
                endTime: "{{ endTime }}"
              relativeDateRange:
                quantity: "{{ quantity }}"
                unit: "{{ unit }}"
          filter: "{{ filter }}"
          chart:
            description: "{{ description }}"
            height: {{ height }}
            chartType: "{{ chartType }}"
            createTime: "{{ createTime }}"
            updateTime: "{{ updateTime }}"
            action:
              conversationFilter: "{{ conversationFilter }}"
              redirectAction:
                relativePath: "{{ relativePath }}"
                queryParams: "{{ queryParams }}"
            width: {{ width }}
            dataSource:
              generativeInsights:
                chartSpec: "{{ chartSpec }}"
                sqlQuery: "{{ sqlQuery }}"
                chartCheckpoint: "{{ chartCheckpoint }}"
                chartConversations: "{{ chartConversations }}"
                request: "{{ request }}"
                sqlComparisonKey: "{{ sqlComparisonKey }}"
              queryMetrics:
                request: "{{ request }}"
            filter: "{{ filter }}"
            name: "{{ name }}"
            dateRangeConfig:
              absoluteDateRange:
                startTime: "{{ startTime }}"
                endTime: "{{ endTime }}"
              relativeDateRange:
                quantity: "{{ quantity }}"
                unit: "{{ unit }}"
            displayName: "{{ displayName }}"
            chartVisualizationType: "{{ chartVisualizationType }}"
          chartReference: "{{ chartReference }}"
      description: "{{ description }}"
      width: {{ width }}
      containerId: "{{ containerId }}"
      dateRangeConfig:
        absoluteDateRange:
          startTime: "{{ startTime }}"
          endTime: "{{ endTime }}"
        relativeDateRange:
          quantity: "{{ quantity }}"
          unit: "{{ unit }}"
  - name: description
    value: "{{ description }}"
    description: |
      Dashboard description
  - name: dashboardId
    value: "{{ dashboardId }}"

UPDATE examples

patch

Updates a Dashboard.

UPDATE google.contactcenterinsights.dashboards
SET 
data__dateRangeConfig = '{{ dateRangeConfig }}',
data__name = '{{ name }}',
data__filter = '{{ filter }}',
data__displayName = '{{ displayName }}',
data__rootContainer = '{{ rootContainer }}',
data__description = '{{ description }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dashboardsId = '{{ dashboardsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
dateRangeConfig,
description,
displayName,
filter,
readOnly,
rootContainer,
updateTime;

DELETE examples

delete

Deletes a Dashboard.

DELETE FROM google.contactcenterinsights.dashboards
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dashboardsId = '{{ dashboardsId }}' --required
;