# Dashboards

## Get Embeddable URL

`v1.dashboards.get_embeddable_url(DashboardGetEmbeddableURLParams**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:** `str`

- **dashboard:** `Literal["invoices", "usage", "credits", "commits_and_credits"]`

  The type of dashboard to retrieve.

  - `"invoices"`

  - `"usage"`

  - `"credits"`

  - `"commits_and_credits"`

- **bm\_group\_key\_overrides:** `Iterable[BmGroupKeyOverride]`

  Optional list of billable metric group key overrides

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

    The name of the billable metric group key.

  - **display\_name:** `str`

    The display name for the billable metric group key

  - **value\_display\_names:** `Dict[str, object]`

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

- **color\_overrides:** `Iterable[ColorOverride]`

  Optional list of colors to override

  - **name:** `Literal["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:** `str`

    Hex value representation of the color

- **dashboard\_options:** `Iterable[DashboardOption]`

  Optional dashboard specific options

  - **key:** `str`

    The option key name

  - **value:** `str`

    The option value

### Returns

- `class DashboardGetEmbeddableURLResponse`

  - **data:** `Data`

    - **url:** `Optional[str]`

### Example

```python
from metronome import Metronome

client = Metronome(
    bearer_token="My Bearer Token",
)
response = client.v1.dashboards.get_embeddable_url(
    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",
    }],
)
print(response.data)
```