# Dashboards

## Get Embeddable URL

`client.V1.Dashboards.GetEmbeddableURL(ctx, body) (*V1DashboardGetEmbeddableURLResponse, error)`

**post** `/v1/dashboards/getEmbeddableUrl`

Retrieve an embeddable dashboard url for a customer.  The dashboard can be embedded using an iframe in a website.  This will show information such as usage data and customer invoices.

### Parameters

- **body:** `V1DashboardGetEmbeddableURLParams`

  - **CustomerID:** `param.Field[string]`

  - **Dashboard:** `param.Field[V1DashboardGetEmbeddableURLParamsDashboard]`

    The type of dashboard to retrieve.

    - `V1DashboardGetEmbeddableURLParamsDashboard`

    - `V1DashboardGetEmbeddableURLParamsDashboard`

    - `V1DashboardGetEmbeddableURLParamsDashboard`

    - `V1DashboardGetEmbeddableURLParamsDashboard`

  - **BmGroupKeyOverrides:** `param.Field[[]V1DashboardGetEmbeddableURLParamsBmGroupKeyOverride]`

    Optional list of billable metric group key overrides

    - **GroupKeyName:** `string`

      The name of the billable metric group key.

    - **DisplayName:** `string`

      The display name for the billable metric group key

    - **ValueDisplayNames:** `map[string, unknown]`

      <key, value> pairs of the billable metric group key values and their display names. e.g. {"a": "Asia", "b": "Euro"}

  - **ColorOverrides:** `param.Field[[]V1DashboardGetEmbeddableURLParamsColorOverride]`

    Optional list of colors to override

    - **Name:** `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      The color to override

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

      - `V1DashboardGetEmbeddableURLParamsColorOverridesName`

    - **Value:** `string`

      Hex value representation of the color

  - **DashboardOptions:** `param.Field[[]V1DashboardGetEmbeddableURLParamsDashboardOption]`

    Optional dashboard specific options

    - **Key:** `string`

      The option key name

    - **Value:** `string`

      The option value

### Returns

- Not supported

  - **Data:** `V1DashboardGetEmbeddableURLResponseData`

    - **URL:** `string`

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/Metronome-Industries/metronome-go"
  "github.com/Metronome-Industries/metronome-go/option"
)

func main() {
  client := metronome.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.V1.Dashboards.GetEmbeddableURL(context.TODO(), metronome.V1DashboardGetEmbeddableURLParams{
    CustomerID: metronome.F("4db51251-61de-4bfe-b9ce-495e244f3491"),
    Dashboard: metronome.F(metronome.V1DashboardGetEmbeddableURLParamsDashboardInvoices),
    BmGroupKeyOverrides: metronome.F([]metronome.V1DashboardGetEmbeddableURLParamsBmGroupKeyOverride{metronome.V1DashboardGetEmbeddableURLParamsBmGroupKeyOverride{
      GroupKeyName: metronome.F("tenant_id"),
      DisplayName: metronome.F("Org ID"),
      ValueDisplayNames: metronome.F(map[string]interface{}{
      "48ecb18f358f": "Cluster EU",
      "e358f3ce242d": "Cluster APAC",
      }),
    }}),
    ColorOverrides: metronome.F([]metronome.V1DashboardGetEmbeddableURLParamsColorOverride{metronome.V1DashboardGetEmbeddableURLParamsColorOverride{
      Name: metronome.F(metronome.V1DashboardGetEmbeddableURLParamsColorOverridesNameGrayDark),
      Value: metronome.F("#ff0000"),
    }}),
    DashboardOptions: metronome.F([]metronome.V1DashboardGetEmbeddableURLParamsDashboardOption{metronome.V1DashboardGetEmbeddableURLParamsDashboardOption{
      Key: metronome.F("show_zero_usage_line_items"),
      Value: metronome.F("false"),
    }, metronome.V1DashboardGetEmbeddableURLParamsDashboardOption{
      Key: metronome.F("hide_voided_invoices"),
      Value: metronome.F("true"),
    }}),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}
```