# User Dashboard

> **Package : spaceone.api.cost\_analysis.v1**

## UserDashboard

{% hint style="info" %}
**UserDashboard Methods:**
{% endhint %}

| Method                | Request                                                   | Response                                                                                                           |
| --------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |
| [**create**](#create) | [CreateUserDashboardRequest](#createuserdashboardrequest) | [UserDashboardInfo](#userdashboardinfo)                                                                            |
| [**update**](#update) | [UpdateUserDashboardRequest](#updateuserdashboardrequest) | [UserDashboardInfo](#userdashboardinfo)                                                                            |
| [**delete**](#delete) | [UserDashboardRequest](#userdashboardrequest)             | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto)   |
| [**get**](#get)       | [GetUserDashboardRequest](#getuserdashboardrequest)       | [UserDashboardInfo](#userdashboardinfo)                                                                            |
| [**list**](#list)     | [UserDashboardQuery](#userdashboardquery)                 | [UserDashboardsInfo](#userdashboardsinfo)                                                                          |
| [**stat**](#stat)     | [UserDashboardStatQuery](#userdashboardstatquery)         | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |

### create

> **POST** /cost-analysis/v1/user-dashboards

| Type     | Message                                                   |
| -------- | --------------------------------------------------------- |
| Request  | [CreateUserDashboardRequest](#createuserdashboardrequest) |
| Response | [UserDashboardInfo](#userdashboardinfo)                   |

### update

> **PUT** /cost-analysis/v1/user-dashboard/{user\_dashboard\_id}

| Type     | Message                                                   |
| -------- | --------------------------------------------------------- |
| Request  | [UpdateUserDashboardRequest](#updateuserdashboardrequest) |
| Response | [UserDashboardInfo](#userdashboardinfo)                   |

### delete

> **DELETE** /cost-analysis/v1/user-dashboard/{user\_dashboard\_id}

| Type     | Message                                                                                                          |
| -------- | ---------------------------------------------------------------------------------------------------------------- |
| Request  | [UserDashboardRequest](#userdashboardrequest)                                                                    |
| Response | [google.protobuf.Empty](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/empty.proto) |

### get

> **GET** /cost-analysis/v1/user-dashboard/{user\_dashboard\_id}

| Type     | Message                                             |
| -------- | --------------------------------------------------- |
| Request  | [GetUserDashboardRequest](#getuserdashboardrequest) |
| Response | [UserDashboardInfo](#userdashboardinfo)             |

### list

> **GET** /cost-analysis/v1/user-dashboards
>
> **POST** /cost-analysis/v1/user-dashboards/search

| Type     | Message                                   |
| -------- | ----------------------------------------- |
| Request  | [UserDashboardQuery](#userdashboardquery) |
| Response | [UserDashboardsInfo](#userdashboardsinfo) |

### stat

> **POST** /cost-analysis/v1/user-dashboards/stat

| Type     | Message                                                                                                            |
| -------- | ------------------------------------------------------------------------------------------------------------------ |
| Request  | [UserDashboardStatQuery](#userdashboardstatquery)                                                                  |
| Response | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |

##

## Message

### CreateUserDashboardRequest

| Field               | Type                                                                                                               | Required | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------------------ | -------- | ----------- |
| name                | string                                                                                                             | ✔        |             |
| default\_layout\_id | string                                                                                                             | ✘        |             |
| custom\_layouts     | [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/overview)                | ✘        |             |
| default\_filter     | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ✘        |             |
| period\_type        | <ul><li>NONE</li><li>AUTO</li><li>FIXED</li></ul>                                                                  | ✘        |             |
| period              | [UserDashboardPeriod](#userdashboardperiod)                                                                        | ✘        |             |
| tags                | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ✘        |             |
| domain\_id          | string                                                                                                             | ✔        |             |

### GetUserDashboardRequest

| Field               | Type           | Required | Description |
| ------------------- | -------------- | :------: | ----------- |
| user\_dashboard\_id | string         |     ✔    |             |
| domain\_id          | string         |     ✔    |             |
| only                | list of string |     ✘    |             |

### UpdateUserDashboardRequest

| Field               | Type                                                                                                               | Required | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------------------ | -------- | ----------- |
| user\_dashboard\_id | string                                                                                                             | ✔        |             |
| name                | string                                                                                                             | ✘        |             |
| default\_layout\_id | string                                                                                                             | ✘        |             |
| custom\_layouts     | [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/overview)                | ✘        |             |
| default\_filter     | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ✘        |             |
| period\_type        | <ul><li>NONE</li><li>AUTO</li><li>FIXED</li></ul>                                                                  | ✘        |             |
| period              | [UserDashboardPeriod](#userdashboardperiod)                                                                        | ✘        |             |
| tags                | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) | ✘        |             |
| domain\_id          | string                                                                                                             | ✔        |             |

### UserDashboardInfo

| Field               | Type                                                                                                               | Description |
| ------------------- | ------------------------------------------------------------------------------------------------------------------ | ----------- |
| user\_dashboard\_id | string                                                                                                             |             |
| name                | string                                                                                                             |             |
| default\_layout\_id | string                                                                                                             |             |
| custom\_layouts     | [google.protobuf.ListValue](https://developers.google.com/protocol-buffers/docs/reference/overview)                |             |
| default\_filter     | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |
| period\_type        | <ul><li>NONE</li><li>AUTO</li><li>FIXED</li></ul>                                                                  |             |
| period              | [UserDashboardPeriod](#userdashboardperiod)                                                                        |             |
| tags                | [google.protobuf.Struct](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto) |             |
| user\_id            | string                                                                                                             |             |
| domain\_id          | string                                                                                                             |             |
| created\_at         | string                                                                                                             |             |
| updated\_at         | string                                                                                                             |             |

### UserDashboardPeriod

| Field | Type   | Description |
| ----- | ------ | ----------- |
| start | string |             |
| end   | string |             |

### UserDashboardQuery

| Field               | Type                                                                                               | Required | Description |
| ------------------- | -------------------------------------------------------------------------------------------------- | -------- | ----------- |
| query               | [spaceone.api.core.v1.Query](https://spaceone-dev.gitbook.io/api-reference/common-v1/search-query) | ✘        |             |
| user\_dashboard\_id | string                                                                                             | ✘        |             |
| name                | string                                                                                             | ✘        |             |
| period\_type        | <ul><li>NONE</li><li>AUTO</li><li>FIXED</li></ul>                                                  | ✘        |             |
| user\_id            | string                                                                                             | ✘        |             |
| domain\_id          | string                                                                                             | ✔        |             |

### UserDashboardRequest

| Field               | Type   | Required | Description |
| ------------------- | ------ | :------: | ----------- |
| user\_dashboard\_id | string |     ✔    |             |
| domain\_id          | string |     ✔    |             |

### UserDashboardStatQuery

| Field      | Type                                                                                                             | Required | Description |
| ---------- | ---------------------------------------------------------------------------------------------------------------- | :------: | ----------- |
| query      | [spaceone.api.core.v1.StatisticsQuery](https://spaceone-dev.gitbook.io/api-reference/common-v1/statistics-query) |     ✔    |             |
| domain\_id | string                                                                                                           |     ✔    |             |

### UserDashboardsInfo

| Field        | Type                                                                                            | Description |
| ------------ | ----------------------------------------------------------------------------------------------- | ----------- |
| results      | [list of UserDashboardInfo](#userdashboardinfo)                                                 |             |
| total\_count | [int32](https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/type.proto) |             |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://spaceone-dev.gitbook.io/spaceone-apis/cost_analysis/v1/user-dashboard.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.