# UserDashboard

A UserDashboard is a cost data dashboard customized with a combination of widgets a User want.

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

\
\


## UserDashboard

**UserDashboard Methods:**

| Method                                                                                                                        | Request                                                                                                                                                           | Response                                                                                                                                          |
| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#create) | [CreateUserDashboardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#createuserdashboardrequest) | [UserDashboardInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#userdashboardinfo)   |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#update) | [UpdateUserDashboardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#updateuserdashboardrequest) | [UserDashboardInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#userdashboardinfo)   |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#delete) | [UserDashboardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#userdashboardrequest)             | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#empty)                           |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#get)       | [GetUserDashboardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#getuserdashboardrequest)       | [UserDashboardInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#userdashboardinfo)   |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#list)     | [UserDashboardQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#userdashboardquery)                 | [UserDashboardsInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#userdashboardsinfo) |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#stat)     | [UserDashboardStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#userdashboardstatquery)         | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#struct)                         |

\


### create

Creates a new UserDashboard. Users can use the dashboard in `private`. In addition to the widgets provided by Cloudforet by default, Users can use widgets through the CustomWidget resource to create a UserDashboard that suits their needs.

> **POST** /cost-analysis/v1/user-dashboard/create

\{{< tabs " create " >\}}

\{{< tab "Request Example" >\}}

[CreateUserDashboardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#createuserdashboardrequest)

* **name** (string) `Required`
* **domain\_id** (string) `Required`
* **default\_layout\_id** (string)
* **custom\_layouts** (ListValue)
* **default\_filter** (Struct)
* **period\_type** (PeriodType)
* **period** (UserDashboardPeriod)
* **tags** (Struct)

\{{< highlight json >\}} { "name": "Untitled Dashboard", "custom\_layouts": \[ \[ { "name": "AWS Data-Transfer Cost Trend", "widget\_id": "linegraph-lg-02", "options": { "layout": 100.0, "chart\_desc\_translation\_id": "BILLING.COST\_MANAGEMENT.DASHBOARD.CUSTOMIZE.ADD\_WIDGET\_MODAL.AWS\_DATA\_TRANSFER\_COST\_TREND\_DESC", "chart\_type": "LINE", "chart\_img": "AWS\_Data-Transfer\_Cost\_Trend" } } ], \[ { "options": { "chart\_type": "MAP", "chart\_img": "AWS\_Data-Transfer\_By\_Region", "layout": 100.0, "chart\_desc\_translation\_id": "BILLING.COST\_MANAGEMENT.DASHBOARD.CUSTOMIZE.ADD\_WIDGET\_MODAL.AWS\_DATA\_TRANSFER\_BY\_REGION\_DESC" }, "name": "AWS Data-Transfer by Region", "widget\_id": "map-lg-02" } ], \[ { "options": { "group\_by": "project\_id", "layout": 100.0, "chart\_type": "STACKED\_COLUMN", "chart\_desc\_translation\_id": "BILLING.COST\_MANAGEMENT.DASHBOARD.CUSTOMIZE.ADD\_WIDGET\_MODAL.AWS\_CLOUDFRONT\_COST\_DESC", "chart\_img": "AWS\_CloudFront\_Cost" }, "name": "AWS CloudFront Cost by Project", "widget\_id": "stackedcol-lg-03" } ] ], "default\_filter": {}, "period\_type": "AUTO" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< tab "Response Example" >\}}

[UserDashboardInfo](#USERDASHBOARDINFO)

* **user\_dashboard\_id** (string) `Required`
* **name** (string) `Required`
* **default\_layout\_id** (string) `Required`
* **custom\_layouts** (ListValue) `Required`
* **default\_filter** (Struct) `Required`
* **period\_type** (PeriodType) `Required`
* **period** (UserDashboardPeriod) `Required`
* **tags** (Struct) `Required`
* **user\_id** (string) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

\{{< highlight json >\}} { "user\_dashboard\_id": "user-dash-bf3f5f5ffa03", "name": "Untitled Dashboard", "custom\_layouts": \[ \[ { "options": { "chart\_type": "LINE", "chart\_desc\_translation\_id": "BILLING.COST\_MANAGEMENT.DASHBOARD.CUSTOMIZE.ADD\_WIDGET\_MODAL.AWS\_DATA\_TRANSFER\_COST\_TREND\_DESC", "layout": 100.0, "chart\_img": "AWS\_Data-Transfer\_Cost\_Trend" }, "widget\_id": "linegraph-lg-02", "name": "AWS Data-Transfer Cost Trend" } ], \[ { "name": "AWS Data-Transfer by Region", "widget\_id": "map-lg-02", "options": { "chart\_img": "AWS\_Data-Transfer\_By\_Region", "chart\_type": "MAP", "chart\_desc\_translation\_id": "BILLING.COST\_MANAGEMENT.DASHBOARD.CUSTOMIZE.ADD\_WIDGET\_MODAL.AWS\_DATA\_TRANSFER\_BY\_REGION\_DESC", "layout": 100.0 } } ], \[ { "widget\_id": "stackedcol-lg-03", "name": "AWS CloudFront Cost by Project", "options": { "layout": 100.0, "chart\_desc\_translation\_id": "BILLING.COST\_MANAGEMENT.DASHBOARD.CUSTOMIZE.ADD\_WIDGET\_MODAL.AWS\_CLOUDFRONT\_COST\_DESC", "chart\_img": "AWS\_CloudFront\_Cost", "group\_by": "project\_id", "chart\_type": "STACKED\_COLUMN" } } ] ], "default\_filter": {}, "period\_type": "AUTO", "tags": {}, "user\_id": "seolmin@mz.co.kr", "domain\_id": "domain-58010aa2e451", "created\_at": "2022-07-19T05:58:52.065Z", "updated\_at": "2022-07-19T05:58:52.065Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### update

Updates a specific UserDashboard. You can make changes in widgets, including default widgets and CustomWidegets.

> **POST** /cost-analysis/v1/user-dashboard/update

\{{< tabs " update " >\}}

\{{< tab "Request Example" >\}}

[UpdateUserDashboardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#updateuserdashboardrequest)

* **user\_dashboard\_id** (string) `Required`
* **domain\_id** (string) `Required`
* **name** (string)
* **default\_layout\_id** (string)
* **custom\_layouts** (ListValue)
* **default\_filter** (Struct)
* **period\_type** (PeriodType)
* **period** (UserDashboardPeriod)
* **tags** (Struct)

\{{< highlight json >\}} { "user\_dashboard\_id": "user-dash-bf3f5f5ffa03", "name": "Untitled Dashboard2", "custom\_layouts": \[ \[{ "options": { "chart\_desc\_translation\_id": "BILLING.COST\_MANAGEMENT.DASHBOARD.CUSTOMIZE.ADD\_WIDGET\_MODAL.AWS\_DATA\_TRANSFER\_COST\_TREND\_DESC", "chart\_type": "LINE", "chart\_img": "AWS\_Data-Transfer\_Cost\_Trend", "layout": 100.0}, "name": "AWS Data-Transfer Cost Trend", "widget\_id": "linegraph-lg-02"}], \[{ "name": "AWS Data-Transfer by Region", "options": { "chart\_type": "MAP", "chart\_desc\_translation\_id": "BILLING.COST\_MANAGEMENT.DASHBOARD.CUSTOMIZE.ADD\_WIDGET\_MODAL.AWS\_DATA\_TRANSFER\_BY\_REGION\_DESC", "layout": 100.0, "chart\_img": "AWS\_Data-Transfer\_By\_Region"}, "widget\_id": "map-lg-02"}], \[{ "name": "AWS CloudFront Cost by Project", "widget\_id": "stackedcol-lg-03", "options": { "layout": 100.0, "chart\_img": "AWS\_CloudFront\_Cost", "chart\_desc\_translation\_id": "BILLING.COST\_MANAGEMENT.DASHBOARD.CUSTOMIZE.ADD\_WIDGET\_MODAL.AWS\_CLOUDFRONT\_COST\_DESC", "chart\_type": "STACKED\_COLUMN", "group\_by": "project\_id"} }] ] } \{{< /highlight >\}} \{{< /tab >\}}

\{{< tab "Response Example" >\}}

[UserDashboardInfo](#USERDASHBOARDINFO)

* **user\_dashboard\_id** (string) `Required`
* **name** (string) `Required`
* **default\_layout\_id** (string) `Required`
* **custom\_layouts** (ListValue) `Required`
* **default\_filter** (Struct) `Required`
* **period\_type** (PeriodType) `Required`
* **period** (UserDashboardPeriod) `Required`
* **tags** (Struct) `Required`
* **user\_id** (string) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

\{{< highlight json >\}} { "user\_dashboard\_id": "user-dash-bf3f5f5ffa03", "name": "Untitled Dashboard", "custom\_layouts": \[ \[ { "options": { "chart\_type": "LINE", "chart\_desc\_translation\_id": "BILLING.COST\_MANAGEMENT.DASHBOARD.CUSTOMIZE.ADD\_WIDGET\_MODAL.AWS\_DATA\_TRANSFER\_COST\_TREND\_DESC", "layout": 100.0, "chart\_img": "AWS\_Data-Transfer\_Cost\_Trend" }, "widget\_id": "linegraph-lg-02", "name": "AWS Data-Transfer Cost Trend" } ], \[ { "name": "AWS Data-Transfer by Region", "widget\_id": "map-lg-02", "options": { "chart\_img": "AWS\_Data-Transfer\_By\_Region", "chart\_type": "MAP", "chart\_desc\_translation\_id": "BILLING.COST\_MANAGEMENT.DASHBOARD.CUSTOMIZE.ADD\_WIDGET\_MODAL.AWS\_DATA\_TRANSFER\_BY\_REGION\_DESC", "layout": 100.0 } } ], \[ { "widget\_id": "stackedcol-lg-03", "name": "AWS CloudFront Cost by Project", "options": { "layout": 100.0, "chart\_desc\_translation\_id": "BILLING.COST\_MANAGEMENT.DASHBOARD.CUSTOMIZE.ADD\_WIDGET\_MODAL.AWS\_CLOUDFRONT\_COST\_DESC", "chart\_img": "AWS\_CloudFront\_Cost", "group\_by": "project\_id", "chart\_type": "STACKED\_COLUMN" } } ] ], "default\_filter": {}, "period\_type": "AUTO", "tags": {}, "user\_id": "seolmin@mz.co.kr", "domain\_id": "domain-58010aa2e451", "created\_at": "2022-07-19T05:58:52.065Z", "updated\_at": "2022-07-19T05:58:52.065Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### delete

Deletes a specific UserDashboard. You must specify the `user_dashboard_id` of the UserDashboard to delete.

> **POST** /cost-analysis/v1/user-dashboard/delete

\{{< tabs " delete " >\}}

\{{< tab "Request Example" >\}}

[UserDashboardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#userdashboardrequest)

* **user\_dashboard\_id** (string) `Required`
* **domain\_id** (string) `Required`

\{{< highlight json >\}} { "user\_dashboard\_id": "user-dash-d1bd5d8cb6d7" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### get

Gets a specific UserDashboard. Prints detailed information about the UserDashboard, including widegts used.

> **POST** /cost-analysis/v1/user-dashboard/get

\{{< tabs " get " >\}}

\{{< tab "Request Example" >\}}

[GetUserDashboardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/UserDashboard/README.md#getuserdashboardrequest)

* **user\_dashboard\_id** (string) `Required`
* **domain\_id** (string) `Required`
* **only** (string) `Repeated`

\{{< highlight json >\}} { "user\_dashboard\_id": "user-dash-d1bd5d8cb6d7" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< tab "Response Example" >\}}

[UserDashboardInfo](#USERDASHBOARDINFO)

* **user\_dashboard\_id** (string) `Required`
* **name** (string) `Required`
* **default\_layout\_id** (string) `Required`
* **custom\_layouts** (ListValue) `Required`
* **default\_filter** (Struct) `Required`
* **period\_type** (PeriodType) `Required`
* **period** (UserDashboardPeriod) `Required`
* **tags** (Struct) `Required`
* **user\_id** (string) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

\{{< highlight json >\}} { "user\_dashboard\_id": "user-dash-bf3f5f5ffa03", "name": "Untitled Dashboard", "custom\_layouts": \[ \[ { "options": { "chart\_type": "LINE", "chart\_desc\_translation\_id": "BILLING.COST\_MANAGEMENT.DASHBOARD.CUSTOMIZE.ADD\_WIDGET\_MODAL.AWS\_DATA\_TRANSFER\_COST\_TREND\_DESC", "layout": 100.0, "chart\_img": "AWS\_Data-Transfer\_Cost\_Trend" }, "widget\_id": "linegraph-lg-02", "name": "AWS Data-Transfer Cost Trend" } ], \[ { "name": "AWS Data-Transfer by Region", "widget\_id": "map-lg-02", "options": { "chart\_img": "AWS\_Data-Transfer\_By\_Region", "chart\_type": "MAP", "chart\_desc\_translation\_id": "BILLING.COST\_MANAGEMENT.DASHBOARD.CUSTOMIZE.ADD\_WIDGET\_MODAL.AWS\_DATA\_TRANSFER\_BY\_REGION\_DESC", "layout": 100.0 } } ], \[ { "widget\_id": "stackedcol-lg-03", "name": "AWS CloudFront Cost by Project", "options": { "layout": 100.0, "chart\_desc\_translation\_id": "BILLING.COST\_MANAGEMENT.DASHBOARD.CUSTOMIZE.ADD\_WIDGET\_MODAL.AWS\_CLOUDFRONT\_COST\_DESC", "chart\_img": "AWS\_CloudFront\_Cost", "group\_by": "project\_id", "chart\_type": "STACKED\_COLUMN" } } ] ], "default\_filter": {}, "period\_type": "AUTO", "tags": {}, "user\_id": "seolmin@mz.co.kr", "domain\_id": "domain-58010aa2e451", "created\_at": "2022-07-19T05:58:52.065Z", "updated\_at": "2022-07-19T05:58:52.065Z" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### list

Gets a list of all UserDashboards. You can use a query to get a filtered list of UserDashboards.

> **POST** /cost-analysis/v1/user-dashboard/list

\{{< tabs " list " >\}}

\{{< tab "Response Example" >\}}

[UserDashboardsInfo](#USERDASHBOARDSINFO)

* **results** (UserDashboardInfo) `Repeated` `Required`
* **total\_count** (int32) `Required`

\{{< highlight json >\}} { "results": \[ { "user\_dashboard\_id": "user-dash-d1bd5d8cb6d7", "name": "11 Months Public Cloud Cost Summary", "custom\_layouts": \[ \[ { "options": { "layout": 100.0, "chart\_type": "CARD" }, "widget\_id": "card-lg-01", "name": "Budget Usage Summary" } ], \[ { "name": "Project-wise Budget Usage Summary@@", "options": { "chart\_type": "TABLE", "layout": 100.0 }, "widget\_id": "table-lg-01" } ], \[ { "widget\_id": "stackedcol-lg-02", "options": { "layout": 100.0, "group\_by": "product", "chart\_type": "STACKED\_COLUMN" }, "name": "Cost Trend By Product" } ] ], "default\_filter": { "project\_id": \[] }, "period\_type": "FIXED", "period": { "start": "2021-04-01", "end": "2022-02-28" }, "tags": {}, "user\_id": "wanzargen@mz.co.kr", "domain\_id": "domain-58010aa2e451", "created\_at": "2022-03-03T03:36:35.396Z", "updated\_at": "2022-03-03T03:36:35.396Z" }, { "user\_dashboard\_id": "user-dash-965b03793d5b", "name": "AWS CloudFront Cost by Project", "custom\_layouts": \[ \[ { "name": "AWS CloudFront Cost by Project", "widget\_id": "stackedcol-lg-03", "options": { "chart\_type": "STACKED\_COLUMN", "layout": 100.0 } } ], \[ { "widget\_id": "stackedcol-lg-03", "options": { "layout": 100.0, "chart\_type": "STACKED\_COLUMN", "group\_by": "service\_account\_id" }, "name": "AWS CloudFront Cost by Service Account" } ], \[ { "options": { "layout": 100.0, "chart\_type": "LINE" }, "name": "AWS Data-Transfer Cost Trend", "widget\_id": "linegraph-lg-02" } ] ], "default\_filter": {}, "period\_type": "FIXED", "period": { "start": "2021-05-01", "end": "2022-04-30" }, "tags": {}, "user\_id": "wanzargen@mz.co.kr", "domain\_id": "domain-58010aa2e451", "created\_at": "2022-04-07T01:13:28.494Z", "updated\_at": "2022-04-07T01:13:28.494Z" } ], "total\_count": 48 } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### stat

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

\
\


## Message

### CreateUserDashboardRequest

* **name** (string) `Required`
* **domain\_id** (string) `Required`
* **default\_layout\_id** (string)
* **custom\_layouts** (ListValue)
* **default\_filter** (Struct)
* **period\_type** (PeriodType)
* **period** (UserDashboardPeriod)
*   **tags** (Struct)

    \


### GetUserDashboardRequest

* **user\_dashboard\_id** (string) `Required`
* **domain\_id** (string) `Required`
*   **only** (string) `Repeated`

    \


### UpdateUserDashboardRequest

* **user\_dashboard\_id** (string) `Required`
* **domain\_id** (string) `Required`
* **name** (string)
* **default\_layout\_id** (string)
* **custom\_layouts** (ListValue)
* **default\_filter** (Struct)
* **period\_type** (PeriodType)
* **period** (UserDashboardPeriod)
*   **tags** (Struct)

    \


### UserDashboardInfo

* **user\_dashboard\_id** (string) `Required`
* **name** (string) `Required`
* **default\_layout\_id** (string) `Required`
* **custom\_layouts** (ListValue) `Required`
* **default\_filter** (Struct) `Required`
* **period\_type** (PeriodType) `Required`
* **period** (UserDashboardPeriod) `Required`
* **tags** (Struct) `Required`
* **user\_id** (string) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
*   **updated\_at** (string) `Required`

    \


### UserDashboardPeriod

* **start** (string) `Required`
*   **end** (string) `Required`

    \


### UserDashboardQuery

* **domain\_id** (string) `Required`
* **query** (Query)
* **user\_dashboard\_id** (string)
* **name** (string)
* **period\_type** (PeriodType)
*   **user\_id** (string)

    \


### UserDashboardRequest

* **user\_dashboard\_id** (string) `Required`
*   **domain\_id** (string) `Required`

    \


### UserDashboardStatQuery

* **query** (StatisticsQuery) `Required`
*   **domain\_id** (string) `Required`

    \


### UserDashboardsInfo

* **results** (UserDashboardInfo) `Repeated` `Required`
*   **total\_count** (int32) `Required`

    \
