Get Embeddable URL

Get an embeddable customer dashboard

client.v1.dashboards.getEmbeddableURL(, ?):

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

Hide ParametersShow Parameters

customer_idstring

formatuuid

dashboardunion

"invoices" | "usage" | "credits" | "commits_and_credits"

The type of dashboard to retrieve.

Hide ParametersShow Parameters

"invoices"

"usage"

"credits"

"commits_and_credits"

bm_group_key_overridesarray

optional

Array<BmGroupKeyOverride>

Optional list of billable metric group key overrides

Hide ParametersShow Parameters

group_key_namestring

The name of the billable metric group key.

display_namestring

optional

The display name for the billable metric group key

value_display_namesRecord<string, unknown>

optional

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

color_overridesarray

optional

Array<ColorOverride>

Optional list of colors to override

Hide ParametersShow Parameters

nameunion

optional

"Gray_dark" | "Gray_medium" | "Gray_light" | 18 more

The color to override

Hide ParametersShow Parameters

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

valuestring

optional

Hex value representation of the color

dashboard_optionsarray

optional

Array<DashboardOption>

Optional dashboard specific options

Hide ParametersShow Parameters

keystring

The option key name

valuestring

The option value

Returns

DashboardGetEmbeddableURLResponse

Hide ParametersShow Parameters

data

Hide ParametersShow Parameters

urlstring

optional

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);

200 Example

{
  "data": {
    "url": "url"
  }
}