## Get Embeddable URL

`client.v1.dashboards.getEmbeddableURL(DashboardGetEmbeddableURLParamsbody, RequestOptionsoptions?): 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

- **body:** `DashboardGetEmbeddableURLParams`

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

    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:** `Record<string, unknown>`

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

  - **color\_overrides:** `Array<ColorOverride>`

    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<DashboardOption>`

    Optional dashboard specific options

    - **key:** `string`

      The option key name

    - **value:** `string`

      The option value

### Returns

- `DashboardGetEmbeddableURLResponse`
  - **data:** `Data`

    - **url:** `string`

### Example

```node
import Metronome from '@metronome/sdk';

const client = new Metronome({
  bearerToken: 'My Bearer Token',
});

const response = await client.v1.dashboards.getEmbeddableURL({
  customer_id: '4db51251-61de-4bfe-b9ce-495e244f3491',
  dashboard: 'invoices',
  bm_group_key_overrides: [
    {
      group_key_name: 'tenant_id',
      display_name: 'Org ID',
      value_display_names: { '48ecb18f358f': 'Cluster EU', e358f3ce242d: 'Cluster APAC' },
    },
  ],
  color_overrides: [{ name: 'Gray_dark', value: '#ff0000' }],
  dashboard_options: [
    { key: 'show_zero_usage_line_items', value: 'false' },
    { key: 'hide_voided_invoices', value: 'true' },
  ],
});

console.log(response.data);
```