Skip to main content
POST
/
v1
/
dashboards
/
getEmbeddableUrl
Get an embeddable customer dashboard
curl --request POST \
  --url https://api.metronome.com/v1/dashboards/getEmbeddableUrl \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "4db51251-61de-4bfe-b9ce-495e244f3491",
  "dashboard": "invoices",
  "dashboard_options": [
    {
      "key": "show_zero_usage_line_items",
      "value": "false"
    },
    {
      "key": "hide_voided_invoices",
      "value": "true"
    }
  ],
  "color_overrides": [
    {
      "name": "Gray_dark",
      "value": "#ff0000"
    }
  ],
  "bm_group_key_overrides": [
    {
      "group_key_name": "tenant_id",
      "display_name": "Org ID",
      "value_display_names": {
        "48ecb18f358f": "Cluster EU",
        "e358f3ce242d": "Cluster APAC"
      }
    }
  ]
}
'
{
  "data": {
    "url": "https://embeddable-dashboards.metronome.com/customers/invoices/v1?..."
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The details of the dashboard to retrieve

​
customer_id
string<uuid>
required
​
dashboard
enum<string>
required

The type of dashboard to retrieve.

Available options:
invoices,
usage,
commits_and_credits
​
dashboard_options
object[]

Optional dashboard specific options

​
color_overrides
object[]

Optional list of colors to override

​
bm_group_key_overrides
object[]

Optional list of billable metric group key overrides

Response

Success

​
data
object
required