Get Embeddable URL

Get an embeddable customer dashboard

client.V1.Dashboards.GetEmbeddableURL(ctx, body) (*, error)

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

CustomerIDfield

param.Field[string]

formatuuid

Dashboardfield

param.Field[V1DashboardGetEmbeddableURLParamsDashboard]

The type of dashboard to retrieve.

Hide ParametersShow Parameters

V1DashboardGetEmbeddableURLParamsDashboardInvoicesconst

V1DashboardGetEmbeddableURLParamsDashboard

"invoices"

V1DashboardGetEmbeddableURLParamsDashboardUsageconst

V1DashboardGetEmbeddableURLParamsDashboard

"usage"

V1DashboardGetEmbeddableURLParamsDashboardCreditsconst

V1DashboardGetEmbeddableURLParamsDashboard

"credits"

V1DashboardGetEmbeddableURLParamsDashboardCommitsAndCreditsconst

V1DashboardGetEmbeddableURLParamsDashboard

"commits_and_credits"

BmGroupKeyOverridesfield

optional

param.Field[[]V1DashboardGetEmbeddableURLParamsBmGroupKeyOverride]

Optional list of billable metric group key overrides

Hide ParametersShow Parameters

GroupKeyNamestring

The name of the billable metric group key.

DisplayNamestring

optional

The display name for the billable metric group key

ValueDisplayNamesmap

optional

map[string, unknown]

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

ColorOverridesfield

optional

param.Field[[]V1DashboardGetEmbeddableURLParamsColorOverride]

Optional list of colors to override

Hide ParametersShow Parameters

Name

optional

The color to override

Hide ParametersShow Parameters

V1DashboardGetEmbeddableURLParamsColorOverridesNameGrayDarkconst

"Gray_dark"

V1DashboardGetEmbeddableURLParamsColorOverridesNameGrayMediumconst

"Gray_medium"

V1DashboardGetEmbeddableURLParamsColorOverridesNameGrayLightconst

"Gray_light"

V1DashboardGetEmbeddableURLParamsColorOverridesNameGrayExtralightconst

"Gray_extralight"

V1DashboardGetEmbeddableURLParamsColorOverridesNameWhiteconst

"White"

V1DashboardGetEmbeddableURLParamsColorOverridesNamePrimaryMediumconst

"Primary_medium"

V1DashboardGetEmbeddableURLParamsColorOverridesNamePrimaryLightconst

"Primary_light"

V1DashboardGetEmbeddableURLParamsColorOverridesNameUsageLine0const

"UsageLine_0"

V1DashboardGetEmbeddableURLParamsColorOverridesNameUsageLine1const

"UsageLine_1"

V1DashboardGetEmbeddableURLParamsColorOverridesNameUsageLine2const

"UsageLine_2"

V1DashboardGetEmbeddableURLParamsColorOverridesNameUsageLine3const

"UsageLine_3"

V1DashboardGetEmbeddableURLParamsColorOverridesNameUsageLine4const

"UsageLine_4"

V1DashboardGetEmbeddableURLParamsColorOverridesNameUsageLine5const

"UsageLine_5"

V1DashboardGetEmbeddableURLParamsColorOverridesNameUsageLine6const

"UsageLine_6"

V1DashboardGetEmbeddableURLParamsColorOverridesNameUsageLine7const

"UsageLine_7"

V1DashboardGetEmbeddableURLParamsColorOverridesNameUsageLine8const

"UsageLine_8"

V1DashboardGetEmbeddableURLParamsColorOverridesNameUsageLine9const

"UsageLine_9"

V1DashboardGetEmbeddableURLParamsColorOverridesNamePrimaryGreenconst

"Primary_green"

V1DashboardGetEmbeddableURLParamsColorOverridesNamePrimaryRedconst

"Primary_red"

V1DashboardGetEmbeddableURLParamsColorOverridesNameProgressBarconst

"Progress_bar"

V1DashboardGetEmbeddableURLParamsColorOverridesNameProgressBarBackgroundconst

"Progress_bar_background"

Valuestring

optional

Hex value representation of the color

DashboardOptionsfield

optional

param.Field[[]V1DashboardGetEmbeddableURLParamsDashboardOption]

Optional dashboard specific options

Hide ParametersShow Parameters

Keystring

The option key name

Valuestring

The option value

Returns

V1DashboardGetEmbeddableURLResponsestruct

Hide ParametersShow Parameters

Data

Hide ParametersShow Parameters

URLstring

optional

package main

import (
  "context"
  "fmt"

  "github.com/Metronome-Industries/metronome-go"
  "github.com/Metronome-Industries/metronome-go/option"
)

func main() {
  client := metronome.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.V1.Dashboards.GetEmbeddableURL(context.TODO(), metronome.V1DashboardGetEmbeddableURLParams{
    CustomerID: metronome.F("4db51251-61de-4bfe-b9ce-495e244f3491"),
    Dashboard: metronome.F(metronome.V1DashboardGetEmbeddableURLParamsDashboardInvoices),
    BmGroupKeyOverrides: metronome.F([]metronome.V1DashboardGetEmbeddableURLParamsBmGroupKeyOverride{metronome.V1DashboardGetEmbeddableURLParamsBmGroupKeyOverride{
      GroupKeyName: metronome.F("tenant_id"),
      DisplayName: metronome.F("Org ID"),
      ValueDisplayNames: metronome.F(map[string]interface{}{
      "48ecb18f358f": "Cluster EU",
      "e358f3ce242d": "Cluster APAC",
      }),
    }}),
    ColorOverrides: metronome.F([]metronome.V1DashboardGetEmbeddableURLParamsColorOverride{metronome.V1DashboardGetEmbeddableURLParamsColorOverride{
      Name: metronome.F(metronome.V1DashboardGetEmbeddableURLParamsColorOverridesNameGrayDark),
      Value: metronome.F("#ff0000"),
    }}),
    DashboardOptions: metronome.F([]metronome.V1DashboardGetEmbeddableURLParamsDashboardOption{metronome.V1DashboardGetEmbeddableURLParamsDashboardOption{
      Key: metronome.F("show_zero_usage_line_items"),
      Value: metronome.F("false"),
    }, metronome.V1DashboardGetEmbeddableURLParamsDashboardOption{
      Key: metronome.F("hide_voided_invoices"),
      Value: metronome.F("true"),
    }}),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}

200 Example

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