## Get Embeddable URL

`v1.dashboards.get_embeddable_url(**kwargs) -> DashboardGetEmbeddableURLResponse`

**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

- **customer\_id:** `String`

- **dashboard:** `:invoices | :usage | :credits | :commits_and_credits`

  The type of dashboard to retrieve.

  - `:invoices`

  - `:usage`

  - `:credits`

  - `:commits_and_credits`

- **bm\_group\_key\_overrides:** `Array[{ group_key_name, display_name, value_display_names}]`

  Optional list of billable metric group key overrides

  - **group\_key\_name:** `String`

    The name of the billable metric group key.

  - **display\_name:** `String`

    The display name for the billable metric group key

  - **value\_display\_names:** `Hash[Symbol, untyped]`

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

- **color\_overrides:** `Array[{ name, value}]`

  Optional list of colors to override

  - **name:** `:Gray_dark | :Gray_medium | :Gray_light | 18 more`

    The color to override

    - `:Gray_dark`

    - `:Gray_medium`

    - `:Gray_light`

    - `:Gray_extralight`

    - `:White`

    - `:Primary_medium`

    - `:Primary_light`

    - `:UsageLine_0`

    - `:UsageLine_1`

    - `:UsageLine_2`

    - `:UsageLine_3`

    - `:UsageLine_4`

    - `:UsageLine_5`

    - `:UsageLine_6`

    - `:UsageLine_7`

    - `:UsageLine_8`

    - `:UsageLine_9`

    - `:Primary_green`

    - `:Primary_red`

    - `:Progress_bar`

    - `:Progress_bar_background`

  - **value:** `String`

    Hex value representation of the color

- **dashboard\_options:** `Array[{ key, value}]`

  Optional dashboard specific options

  - **key:** `String`

    The option key name

  - **value:** `String`

    The option value

### Returns

- `class DashboardGetEmbeddableURLResponse`

  - **data:** `{ url}`

    - **url:** `String`

### Example

```ruby
require "metronome_sdk"

metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")

response = metronome.v1.dashboards.get_embeddable_url(
  customer_id: "4db51251-61de-4bfe-b9ce-495e244f3491",
  dashboard: :invoices
)

puts(response)
```