Skip to content
Metronome Docs
  • Auto
  • Light
  • Dark
Talk to an expert

Get Embeddable URL

API Reference
V1
Dashboards
Get an embeddable customer dashboard
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.

Body Parameters
customer_idstring
formatuuid
dashboardenum
"invoices" OR "usage" OR "credits" OR "commits_and_credits"

The type of dashboard to retrieve.

Hide ParametersShow Parameters
"invoices"
"usage"
"credits"
"commits_and_credits"
bm_group_key_overridesarray of object
optional

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_namesmap
optional

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

color_overridesarray of object
optional

Optional list of colors to override

Hide ParametersShow Parameters
nameenum
optional
"Gray_dark" OR "Gray_medium" OR "Gray_light" OR 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 of object
optional

Optional dashboard specific options

Hide ParametersShow Parameters
keystring

The option key name

valuestring

The option value

Returns
dataobject
Hide ParametersShow Parameters
urlstring
optional
curl https://api.metronome.com/v1/dashboards/getEmbeddableUrl \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $METRONOME_BEARER_TOKEN" \
    -d '{
          "customer_id": "4db51251-61de-4bfe-b9ce-495e244f3491",
          "dashboard": "invoices"
        }'
200 Example
{
  "data": {
    "url": "url"
  }
}