# PublicDashboard

A PublicDashboard is a cost data dashboard provided to all users by default.

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

\
\


## PublicDashboard

**PublicDashboard Methods:**

| Method                                                                                                                          | Request                                                                                                                                                                 | Response                                                                                                                                                |
| ------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [**create**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#create) | [CreatePublicDashboardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#createpublicdashboardrequest) | [PublicDashboardInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#publicdashboardinfo)   |
| [**update**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#update) | [UpdatePublicDashboardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#updatepublicdashboardrequest) | [PublicDashboardInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#publicdashboardinfo)   |
| [**delete**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#delete) | [PublicDashboardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#publicdashboardrequest)             | [Empty](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#empty)                               |
| [**get**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#get)       | [GetPublicDashboardRequest](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#getpublicdashboardrequest)       | [PublicDashboardInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#publicdashboardinfo)   |
| [**list**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#list)     | [PublicDashboardQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#publicdashboardquery)                 | [PublicDashboardsInfo](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#publicdashboardsinfo) |
| [**stat**](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#stat)     | [PublicDashboardStatQuery](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#publicdashboardstatquery)         | [Struct](https://github.com/cloudforet-io/api-doc/blob/master/content/en/cost_analysis/v1/PublicDashboard/README.md#struct)                             |

\


### create

Creates a new PublicDashboard. This method is used for creating the default dashboard . `Admin` type Users can use the method to add a new dashboard with customized widgets.

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

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

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

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

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

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

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

[PublicDashboardInfo](#PUBLICDASHBOARDINFO)

* **public\_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** (PublicDashboardPeriod) `Required`
* **tags** (Struct) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

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

\{{< /tabs >\}}

\


### update

Updates a specific PublicDashboard. Changes the widgets of the PublicDashboard with default widgets and customized widgets. Only `Admin` type Users can use the method.

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

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

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

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

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

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

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

[PublicDashboardInfo](#PUBLICDASHBOARDINFO)

* **public\_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** (PublicDashboardPeriod) `Required`
* **tags** (Struct) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

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

\{{< /tabs >\}}

\


### delete

Deletes a specific PublicDashboard. You must specify the `public_dashboard_id` of the PublicDashboard to delete.

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

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

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

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

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

\{{< highlight json >\}} { "public\_dashboard\_id": "pub-dash-579b38f00dcf" } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### get

Gets a specific PublicDashboard. Prints detailed information about the PublicDashboard, including `custom_layouts` and `period_type`.

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

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

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

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

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

\{{< highlight json >\}} { "public\_dashboard\_id": "pub-dash-579b38f00dcf" } \{{< /highlight >\}} \{{< /tab >\}}

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

[PublicDashboardInfo](#PUBLICDASHBOARDINFO)

* **public\_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** (PublicDashboardPeriod) `Required`
* **tags** (Struct) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
* **updated\_at** (string) `Required`

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

\{{< /tabs >\}}

\


### list

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

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

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

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

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

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

\{{< highlight json >\}} { "query": {} } \{{< /highlight >\}} \{{< /tab >\}}

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

[PublicDashboardsInfo](#PUBLICDASHBOARDSINFO)

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

\{{< highlight json >\}} { "results": \[ { "public\_dashboard\_id": "pub-dash-579b38f00dcf", "name": "CDN & Traffic Cost", "custom\_layouts": \[ \[ { "widget\_id": "linegraph-lg-02", "name": "AWS Data-Transfer Cost Trend", "options": { "chart\_type": "LINE", "layout": 100.0 } } ], \[ { "name": "AWS CloudFront Cost by Project", "options": { "group\_by": "project\_id", "chart\_type": "STACKED\_COLUMN", "layout": 100.0 }, "widget\_id": "stackedcol-lg-03" } ], \[ { "options": { "layout": 100.0, "chart\_type": "MAP" }, "widget\_id": "map-lg-02", "name": "AWS Data-Transfer by Region" } ] ], "default\_filter": { "project\_id": \[], "service\_account\_id": \[], "project\_group\_id": \[], "provider": \[ "google\_cloud", "azure", "aws\_china", "aws" ] }, "period\_type": "AUTO", "tags": {}, "domain\_id": "domain-58010aa2e451", "created\_at": "2022-04-07T02:31:28.197Z", "updated\_at": "2022-04-07T02:31:28.197Z" }, { "public\_dashboard\_id": "pub-dash-fc83ed9bc825", "name": "Monthly Cost Summary", "custom\_layouts": \[ \[ { "options": { "layout": 33.0, "chart\_type": "CARD" }, "widget\_id": "card-sm-01", "name": "Month-to-Date Spend" }, { "name": "Last Month Total Spend", "widget\_id": "card-sm-02", "options": { "layout": 33.0, "chart\_type": "CARD" } }, { "widget\_id": "card-sm-03", "name": "Budget Usage", "options": { "chart\_type": "CARD", "layout": 33.0 } } ], \[ { "name": "Cost By Project", "widget\_id": "treemap-lg-01", "options": { "group\_by": "project\_id", "layout": 100.0, "chart\_type": "TREEMAP" } } ], \[ { "name": "Cost Trend By Project", "widget\_id": "linegraph-lg-01", "options": { "layout": 100.0, "group\_by": "provider", "chart\_type": "LINE" } } ], \[ { "options": { "layout": 100.0, "chart\_type": "STACKED\_COLUMN", "group\_by": "product" }, "widget\_id": "stackedcol-lg-01", "name": "Cost Trend By Product" } ], \[ { "name": "Cost By Provider", "options": { "layout": 50.0, "group\_by": "provider", "chart\_type": "STACKED\_COLUMN" }, "widget\_id": "donut-md-01" }, { "widget\_id": "waffle-md-01", "name": "Budget Status", "options": { "layout": 50.0, "chart\_type": "WAFFLE" } } ], \[ { "options": { "chart\_type": "MAP", "layout": 100.0 }, "widget\_id": "map-lg-01", "name": "Cost By Region" } ] ], "default\_filter": { "provider": \[] }, "period\_type": "AUTO", "tags": {}, "domain\_id": "domain-58010aa2e451", "created\_at": "2022-03-29T05:22:41.283Z", "updated\_at": "2022-03-29T05:22:41.283Z" } ], "total\_count": 3 } \{{< /highlight >\}} \{{< /tab >\}}

\{{< /tabs >\}}

\


### stat

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

\
\


## Message

### CreatePublicDashboardRequest

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

    \


### GetPublicDashboardRequest

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

    \


### PublicDashboardInfo

* **public\_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** (PublicDashboardPeriod) `Required`
* **tags** (Struct) `Required`
* **domain\_id** (string) `Required`
* **created\_at** (string) `Required`
*   **updated\_at** (string) `Required`

    \


### PublicDashboardPeriod

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

    \


### PublicDashboardQuery

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

    \


### PublicDashboardRequest

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

    \


### PublicDashboardStatQuery

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

    \


### PublicDashboardsInfo

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

    \


### UpdatePublicDashboardRequest

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

    \
