Get Embeddable URL

Get an embeddable customer dashboard

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

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_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[{ group_key_name, display_name, value_display_names}]

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_nameshash

optional

Hash[Symbol, untyped]

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

color_overridesarray

optional

Array[{ name, value}]

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[{ key, value}]

Optional dashboard specific options

Hide ParametersShow Parameters

keyString

The option key name

valueString

The option value

Returns

DashboardGetEmbeddableURLResponseclass

Hide ParametersShow Parameters

dataobject

{ url}

Hide ParametersShow Parameters

urlString

optional

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)

200 Example

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