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

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

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

## Request

- Base URL: `https://contactcenterinsights.googleapis.com`
- URL: `https://contactcenterinsights.googleapis.com/v1/projects/{projectsId}/locations/{locationsId}/dashboards`
- 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`

Lists Dashboards.

## Path parameters

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

## Query parameters

- `filter` string
- `orderBy` string
- `pageSize` integer
- `pageToken` string

## Response `200`

Successful response

- GoogleCloudContactcenterinsightsV1ListDashboardsResponse: The response of listing dashboards.
  - `dashboards` GoogleCloudContactcenterinsightsV1Dashboard[]: The dashboards under the parent.
    - `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.
              - …
          - `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.
              - …
            - `queryMetrics` GoogleCloudContactcenterinsightsV1QueryMetrics: Request data that use the existing QueryMetrics.
              - …
          - `dateRangeConfig` GoogleCloudContactcenterinsightsV1DateRangeConfig: Date range configuration for dashboard charts.
            - `absoluteDateRange` GoogleCloudContactcenterinsightsV1QueryInterval: A time window for querying conversations.
              - …
            - `relativeDateRange` GoogleCloudContactcenterinsightsV1DateRangeConfigRelativeDateRange: Relative date range configuration.
              - …
          - `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.
  - `nextPageToken` string: The value returned by the last `ListDashboardsResponse`. This value indicates that this is a continuation of a prior `ListDashboards` call and that the system should return the next page of data.

---

[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)