---
title: "GET /v1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}"
method: GET
path: "/v1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}"
tags: ["projects"]
---

# GET /v1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}

`GET /v1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}`

## Request

- Base URL: `https://contactcenterinsights.googleapis.com`
- URL: `https://contactcenterinsights.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/dashboards/{dashboardsId}`
- Auth: OAuth 2 and OAuth 2
  - Implicit: `https://accounts.google.com/o/oauth2/auth`
  - Scopes: `https://www.googleapis.com/auth/cloud-platform`
  - Authorization code: `https://accounts.google.com/o/oauth2/auth`
  - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/cloud-platform`

Gets a Dashboard.

## Path parameters

- `projectsId` string, required
- `locationsId` string, required
- `dashboardsId` string, required

## Response `200`

Successful response

- GoogleCloudContactcenterinsightsV1Dashboard: Configurable dashboard
  - `createTime` string, google-datetime: Output only. Dashboard creation time.
  - `dateRangeConfig` GoogleCloudContactcenterinsightsV1DateRangeConfig: Date range configuration for dashboard charts.
    - `absoluteDateRange` GoogleCloudContactcenterinsightsV1QueryInterval: A time window for querying conversations.
      - `endTime` string, google-datetime: Required. The end time of the time window.
      - `startTime` string, google-datetime: Required. The start time of the time window.
    - `relativeDateRange` GoogleCloudContactcenterinsightsV1DateRangeConfigRelativeDateRange: Relative date range configuration.
      - `quantity` string, int64: Required. The quantity of units in the past.
      - `unit` 'TIME_UNIT_UNSPECIFIED' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR': Required. The unit of time.
  - `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.
  - `name` string: Identifier. Dashboard resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}
  - `readOnly` boolean: Output only. Whether the dashboard is read-only. All predefined dashboards are read-only and cannot be modified by the user.
  - `rootContainer` GoogleCloudContactcenterinsightsV1Container: Configurable dashboard's container. Container can contain multiple widgets.
    - `containerId` string: Output only. Unique ID for the container.
    - `dateRangeConfig` GoogleCloudContactcenterinsightsV1DateRangeConfig: Date range configuration for dashboard charts.
      - `absoluteDateRange` GoogleCloudContactcenterinsightsV1QueryInterval: A time window for querying conversations.
        - `endTime` string, google-datetime: Required. The end time of the time window.
        - `startTime` string, google-datetime: Required. The start time of the time window.
      - `relativeDateRange` GoogleCloudContactcenterinsightsV1DateRangeConfigRelativeDateRange: Relative date range configuration.
        - `quantity` string, int64: Required. The quantity of units in the past.
        - `unit` 'TIME_UNIT_UNSPECIFIED' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR': Required. The unit of time.
    - `description` string: Container description
    - `displayName` string: User provided display name of the Container.
    - `filter` string: Filter applied to all charts in the container. Should support scope later.
    - `height` integer: The height of the container in grid units.
    - `widgets` GoogleCloudContactcenterinsightsV1Widget[]: Widgets in the Container.
      - `chart` GoogleCloudContactcenterinsightsV1Chart: Configurable dashboard's widget that displays data as a chart.
        - `action` GoogleCloudContactcenterinsightsV1ChartAction: The action to be taken when the chart is clicked.
          - `conversationFilter` string: The conversation filter string.
          - `redirectAction` GoogleCloudContactcenterinsightsV1RedirectAction: The redirect action to be taken when the chart is clicked.
            - `queryParams` object: The query params to be added to the redirect path.
            - `relativePath` string: The relative path to redirect to.
        - `chartType` 'CHART_TYPE_UNSPECIFIED' | 'SYSTEM_DEFINED' | 'USER_DEFINED': Output only. Chart type.
        - `chartVisualizationType` 'CHART_VISUALIZATION_TYPE_UNSPECIFIED' | 'BAR' | 'LINE' | 'AREA' | 'PIE' | 'SCATTER' | 'TABLE' | 'SCORE_CARD' | 'SUNBURST' | 'GAUGE' | 'SANKEY': Chart visualization type.
        - `createTime` string, google-datetime: Output only. Chart create time.
        - `dataSource` GoogleCloudContactcenterinsightsV1ChartDataSource: The request data for visualizing the dataset in the chart.
          - `generativeInsights` GoogleCloudContactcenterinsightsV1GenerativeInsights: Request that use natural language query to generate the chart.
            - `chartCheckpoint` GoogleCloudContactcenterinsightsV1GenerativeInsightsChartCheckpoint: The current chart checkpoint state.
              - …
            - `chartConversations` GoogleCloudContactcenterinsightsV1GenerativeInsightsChartConversation[]: Output only. The chart conversations used to generate the chart.
              - …
            - `chartSpec` object: Chart spec for the chart.
            - `request` object
            - `sqlComparisonKey` string: Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset.
            - `sqlQuery` string: SQL query used to generate the chart.
          - `queryMetrics` GoogleCloudContactcenterinsightsV1QueryMetrics: Request data that use the existing QueryMetrics.
            - `request` object
        - `dateRangeConfig` GoogleCloudContactcenterinsightsV1DateRangeConfig: Date range configuration for dashboard charts.
          - `absoluteDateRange` GoogleCloudContactcenterinsightsV1QueryInterval: A time window for querying conversations.
            - `endTime` string, google-datetime: Required. The end time of the time window.
            - `startTime` string, google-datetime: Required. The start time of the time window.
          - `relativeDateRange` GoogleCloudContactcenterinsightsV1DateRangeConfigRelativeDateRange: Relative date range configuration.
            - `quantity` string, int64: Required. The quantity of units in the past.
            - `unit` 'TIME_UNIT_UNSPECIFIED' | 'DAY' | 'WEEK' | 'MONTH' | 'QUARTER' | 'YEAR': Required. The unit of time.
        - `description` string: Chart description
        - `displayName` string: User provided display name of the chart.
        - `filter` string: Filter applied to all charts in the container. Should support scope later.
        - `height` integer: The height of the chart in grid units.
        - `name` string: Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
        - `updateTime` string, google-datetime: Output only. Chart last update time.
        - `width` integer: The width of the chart in grid units.
      - `chartReference` string: A reference to a chart widget. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
      - `container` GoogleCloudContactcenterinsightsV1Container (recursive)
      - `filter` string: Filter applied to all charts in the container. Should support scope later.
    - `width` integer: The width of the container in grid units.
  - `updateTime` string, google-datetime: Output only. Dashboard last update time.

---

[API](https://skmtc.dev/google/apis/contactcenterinsights.md) - [All operations](https://skmtc.dev/google/apis/contactcenterinsights/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/contactcenterinsights/revisions/895c3ce55ea0?raw)