Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Vantage Provider
  4. API Docs
  5. getBusinessMetrics
Viewing docs for vantage 0.4.4
published on Monday, Oct 26, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

vantage.getBusinessMetrics

vantage
Viewing docs for vantage 0.4.4
published on Monday, Oct 26, 2026 by vantage-sh
Schema (JSON)
vantage-sh/terraform-provider-vantage

    Using getBusinessMetrics

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getBusinessMetrics(opts?: InvokeOptions): Promise<GetBusinessMetricsResult>
function getBusinessMetricsOutput(opts?: InvokeOutputOptions): Output<GetBusinessMetricsResult>
    def get_business_metrics(opts: Optional[InvokeOptions] = None) -> GetBusinessMetricsResult
def get_business_metrics_output(opts: Optional[InvokeOutputOptions] = None) -> Output[GetBusinessMetricsResult]
    func GetBusinessMetrics(ctx *Context, opts ...InvokeOption) (*GetBusinessMetricsResult, error)
func GetBusinessMetricsOutput(ctx *Context, opts ...InvokeOption) GetBusinessMetricsResultOutput

    > Note: This function is named GetBusinessMetrics in the Go SDK.

    public static class GetBusinessMetrics 
{
    public static Task<GetBusinessMetricsResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetBusinessMetricsResult> Invoke(InvokeOptions? opts = null)
    public static Output<GetBusinessMetricsResult> Invoke(InvokeOutputOptions opts)
}
    public static CompletableFuture<GetBusinessMetricsResult> getBusinessMetrics(InvokeOptions options)
public static Output<GetBusinessMetricsResult> getBusinessMetrics(InvokeOptions options)
public static Output<GetBusinessMetricsResult> getBusinessMetrics(InvokeOutputOptions options)

    fn::invoke:
  function: vantage:index/getBusinessMetrics:getBusinessMetrics
  arguments:
    # arguments dictionary
    data "vantage_get_business_metrics" "name" {
    # arguments
}

    getBusinessMetrics Result

    The following output properties are available:

    BusinessMetrics List<GetBusinessMetricsBusinessMetric>
    Id string
    The provider-assigned unique ID for this managed resource.
    BusinessMetrics []GetBusinessMetricsBusinessMetric
    Id string
    The provider-assigned unique ID for this managed resource.
    business_metrics list(object)
    id string
    The provider-assigned unique ID for this managed resource.
    businessMetrics List<GetBusinessMetricsBusinessMetric>
    id String
    The provider-assigned unique ID for this managed resource.
    businessMetrics GetBusinessMetricsBusinessMetric[]
    id string
    The provider-assigned unique ID for this managed resource.
    business_metrics Sequence[GetBusinessMetricsBusinessMetric]
    id str
    The provider-assigned unique ID for this managed resource.
    businessMetrics List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GetBusinessMetricsBusinessMetric

    ClickhouseMetricFields GetBusinessMetricsBusinessMetricClickhouseMetricFields
    CloudwatchFields GetBusinessMetricsBusinessMetricCloudwatchFields
    CostReportTokensWithMetadatas List<GetBusinessMetricsBusinessMetricCostReportTokensWithMetadata>
    The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
    CreatedByToken string
    The token of the Creator of the BusinessMetric.
    DatadogMetricFields GetBusinessMetricsBusinessMetricDatadogMetricFields
    GcpBigqueryMetricFields GetBusinessMetricsBusinessMetricGcpBigqueryMetricFields
    Id string
    The id of the BusinessMetric.
    ImportType string
    The type of import for the BusinessMetric.
    IntegrationToken string
    The Integration token used to import the BusinessMetric.
    MetronomeMetricFields GetBusinessMetricsBusinessMetricMetronomeMetricFields
    SnowflakeMetricFields GetBusinessMetricsBusinessMetricSnowflakeMetricFields
    Title string
    The title of the BusinessMetric.
    Token string
    The token of the BusinessMetric.
    ClickhouseMetricFields GetBusinessMetricsBusinessMetricClickhouseMetricFields
    CloudwatchFields GetBusinessMetricsBusinessMetricCloudwatchFields
    CostReportTokensWithMetadatas []GetBusinessMetricsBusinessMetricCostReportTokensWithMetadata
    The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
    CreatedByToken string
    The token of the Creator of the BusinessMetric.
    DatadogMetricFields GetBusinessMetricsBusinessMetricDatadogMetricFields
    GcpBigqueryMetricFields GetBusinessMetricsBusinessMetricGcpBigqueryMetricFields
    Id string
    The id of the BusinessMetric.
    ImportType string
    The type of import for the BusinessMetric.
    IntegrationToken string
    The Integration token used to import the BusinessMetric.
    MetronomeMetricFields GetBusinessMetricsBusinessMetricMetronomeMetricFields
    SnowflakeMetricFields GetBusinessMetricsBusinessMetricSnowflakeMetricFields
    Title string
    The title of the BusinessMetric.
    Token string
    The token of the BusinessMetric.
    clickhouse_metric_fields object
    cloudwatch_fields object
    cost_report_tokens_with_metadatas list(object)
    The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
    created_by_token string
    The token of the Creator of the BusinessMetric.
    datadog_metric_fields object
    gcp_bigquery_metric_fields object
    id string
    The id of the BusinessMetric.
    import_type string
    The type of import for the BusinessMetric.
    integration_token string
    The Integration token used to import the BusinessMetric.
    metronome_metric_fields object
    snowflake_metric_fields object
    title string
    The title of the BusinessMetric.
    token string
    The token of the BusinessMetric.
    clickhouseMetricFields GetBusinessMetricsBusinessMetricClickhouseMetricFields
    cloudwatchFields GetBusinessMetricsBusinessMetricCloudwatchFields
    costReportTokensWithMetadatas List<GetBusinessMetricsBusinessMetricCostReportTokensWithMetadata>
    The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
    createdByToken String
    The token of the Creator of the BusinessMetric.
    datadogMetricFields GetBusinessMetricsBusinessMetricDatadogMetricFields
    gcpBigqueryMetricFields GetBusinessMetricsBusinessMetricGcpBigqueryMetricFields
    id String
    The id of the BusinessMetric.
    importType String
    The type of import for the BusinessMetric.
    integrationToken String
    The Integration token used to import the BusinessMetric.
    metronomeMetricFields GetBusinessMetricsBusinessMetricMetronomeMetricFields
    snowflakeMetricFields GetBusinessMetricsBusinessMetricSnowflakeMetricFields
    title String
    The title of the BusinessMetric.
    token String
    The token of the BusinessMetric.
    clickhouseMetricFields GetBusinessMetricsBusinessMetricClickhouseMetricFields
    cloudwatchFields GetBusinessMetricsBusinessMetricCloudwatchFields
    costReportTokensWithMetadatas GetBusinessMetricsBusinessMetricCostReportTokensWithMetadata[]
    The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
    createdByToken string
    The token of the Creator of the BusinessMetric.
    datadogMetricFields GetBusinessMetricsBusinessMetricDatadogMetricFields
    gcpBigqueryMetricFields GetBusinessMetricsBusinessMetricGcpBigqueryMetricFields
    id string
    The id of the BusinessMetric.
    importType string
    The type of import for the BusinessMetric.
    integrationToken string
    The Integration token used to import the BusinessMetric.
    metronomeMetricFields GetBusinessMetricsBusinessMetricMetronomeMetricFields
    snowflakeMetricFields GetBusinessMetricsBusinessMetricSnowflakeMetricFields
    title string
    The title of the BusinessMetric.
    token string
    The token of the BusinessMetric.
    clickhouse_metric_fields GetBusinessMetricsBusinessMetricClickhouseMetricFields
    cloudwatch_fields GetBusinessMetricsBusinessMetricCloudwatchFields
    cost_report_tokens_with_metadatas Sequence[GetBusinessMetricsBusinessMetricCostReportTokensWithMetadata]
    The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
    created_by_token str
    The token of the Creator of the BusinessMetric.
    datadog_metric_fields GetBusinessMetricsBusinessMetricDatadogMetricFields
    gcp_bigquery_metric_fields GetBusinessMetricsBusinessMetricGcpBigqueryMetricFields
    id str
    The id of the BusinessMetric.
    import_type str
    The type of import for the BusinessMetric.
    integration_token str
    The Integration token used to import the BusinessMetric.
    metronome_metric_fields GetBusinessMetricsBusinessMetricMetronomeMetricFields
    snowflake_metric_fields GetBusinessMetricsBusinessMetricSnowflakeMetricFields
    title str
    The title of the BusinessMetric.
    token str
    The token of the BusinessMetric.
    clickhouseMetricFields Property Map
    cloudwatchFields Property Map
    costReportTokensWithMetadatas List<Property Map>
    The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter.
    createdByToken String
    The token of the Creator of the BusinessMetric.
    datadogMetricFields Property Map
    gcpBigqueryMetricFields Property Map
    id String
    The id of the BusinessMetric.
    importType String
    The type of import for the BusinessMetric.
    integrationToken String
    The Integration token used to import the BusinessMetric.
    metronomeMetricFields Property Map
    snowflakeMetricFields Property Map
    title String
    The title of the BusinessMetric.
    token String
    The token of the BusinessMetric.

    GetBusinessMetricsBusinessMetricClickhouseMetricFields

    QueryEndpointId string
    The UUID of the ClickHouse query endpoint used to import metrics.
    QueryEndpointId string
    The UUID of the ClickHouse query endpoint used to import metrics.
    query_endpoint_id string
    The UUID of the ClickHouse query endpoint used to import metrics.
    queryEndpointId String
    The UUID of the ClickHouse query endpoint used to import metrics.
    queryEndpointId string
    The UUID of the ClickHouse query endpoint used to import metrics.
    query_endpoint_id str
    The UUID of the ClickHouse query endpoint used to import metrics.
    queryEndpointId String
    The UUID of the ClickHouse query endpoint used to import metrics.

    GetBusinessMetricsBusinessMetricCloudwatchFields

    Dimensions List<GetBusinessMetricsBusinessMetricCloudwatchFieldsDimension>
    The dimensions used to pull specific statistical data for Cloudwatch metrics.
    LabelDimension string
    The dimension used to aggregate the Cloudwatch metrics.
    MetricName string
    The metric name used to import Cloudwatch metrics.
    Namespace string
    The namespace used to import Cloudwatch metrics.
    Region string
    The region used to import Cloudwatch metrics.
    Stat string
    The time aggregation function used to import Cloudwatch metrics.
    Dimensions []GetBusinessMetricsBusinessMetricCloudwatchFieldsDimension
    The dimensions used to pull specific statistical data for Cloudwatch metrics.
    LabelDimension string
    The dimension used to aggregate the Cloudwatch metrics.
    MetricName string
    The metric name used to import Cloudwatch metrics.
    Namespace string
    The namespace used to import Cloudwatch metrics.
    Region string
    The region used to import Cloudwatch metrics.
    Stat string
    The time aggregation function used to import Cloudwatch metrics.
    dimensions list(object)
    The dimensions used to pull specific statistical data for Cloudwatch metrics.
    label_dimension string
    The dimension used to aggregate the Cloudwatch metrics.
    metric_name string
    The metric name used to import Cloudwatch metrics.
    namespace string
    The namespace used to import Cloudwatch metrics.
    region string
    The region used to import Cloudwatch metrics.
    stat string
    The time aggregation function used to import Cloudwatch metrics.
    dimensions List<GetBusinessMetricsBusinessMetricCloudwatchFieldsDimension>
    The dimensions used to pull specific statistical data for Cloudwatch metrics.
    labelDimension String
    The dimension used to aggregate the Cloudwatch metrics.
    metricName String
    The metric name used to import Cloudwatch metrics.
    namespace String
    The namespace used to import Cloudwatch metrics.
    region String
    The region used to import Cloudwatch metrics.
    stat String
    The time aggregation function used to import Cloudwatch metrics.
    dimensions GetBusinessMetricsBusinessMetricCloudwatchFieldsDimension[]
    The dimensions used to pull specific statistical data for Cloudwatch metrics.
    labelDimension string
    The dimension used to aggregate the Cloudwatch metrics.
    metricName string
    The metric name used to import Cloudwatch metrics.
    namespace string
    The namespace used to import Cloudwatch metrics.
    region string
    The region used to import Cloudwatch metrics.
    stat string
    The time aggregation function used to import Cloudwatch metrics.
    dimensions Sequence[GetBusinessMetricsBusinessMetricCloudwatchFieldsDimension]
    The dimensions used to pull specific statistical data for Cloudwatch metrics.
    label_dimension str
    The dimension used to aggregate the Cloudwatch metrics.
    metric_name str
    The metric name used to import Cloudwatch metrics.
    namespace str
    The namespace used to import Cloudwatch metrics.
    region str
    The region used to import Cloudwatch metrics.
    stat str
    The time aggregation function used to import Cloudwatch metrics.
    dimensions List<Property Map>
    The dimensions used to pull specific statistical data for Cloudwatch metrics.
    labelDimension String
    The dimension used to aggregate the Cloudwatch metrics.
    metricName String
    The metric name used to import Cloudwatch metrics.
    namespace String
    The namespace used to import Cloudwatch metrics.
    region String
    The region used to import Cloudwatch metrics.
    stat String
    The time aggregation function used to import Cloudwatch metrics.

    GetBusinessMetricsBusinessMetricCloudwatchFieldsDimension

    Name string
    Value string
    Name string
    Value string
    name string
    value string
    name String
    value String
    name string
    value string
    name str
    value str
    name String
    value String

    GetBusinessMetricsBusinessMetricCostReportTokensWithMetadata

    CalculationType string
    The calculation type applied when this BusinessMetric is used in the CostReport.
    CostReportToken string
    The token of the CostReport the BusinessMetric is attached to.
    Label string
    Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type.
    LabelFilter List<string>
    The labels that the BusinessMetric is filtered by within a particular CostReport.
    LabelFilters Dictionary<string, ImmutableArray<string>>
    The ClickHouse BusinessMetric label filters applied within a CostReport. Each key is required and values within a key are alternatives.
    UnitScale string
    Determines the scale of the BusinessMetric's values within a particular CostReport.
    CalculationType string
    The calculation type applied when this BusinessMetric is used in the CostReport.
    CostReportToken string
    The token of the CostReport the BusinessMetric is attached to.
    Label string
    Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type.
    LabelFilter []string
    The labels that the BusinessMetric is filtered by within a particular CostReport.
    LabelFilters map[string][]string
    The ClickHouse BusinessMetric label filters applied within a CostReport. Each key is required and values within a key are alternatives.
    UnitScale string
    Determines the scale of the BusinessMetric's values within a particular CostReport.
    calculation_type string
    The calculation type applied when this BusinessMetric is used in the CostReport.
    cost_report_token string
    The token of the CostReport the BusinessMetric is attached to.
    label string
    Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type.
    label_filter list(string)
    The labels that the BusinessMetric is filtered by within a particular CostReport.
    label_filters map(list(string))
    The ClickHouse BusinessMetric label filters applied within a CostReport. Each key is required and values within a key are alternatives.
    unit_scale string
    Determines the scale of the BusinessMetric's values within a particular CostReport.
    calculationType String
    The calculation type applied when this BusinessMetric is used in the CostReport.
    costReportToken String
    The token of the CostReport the BusinessMetric is attached to.
    label String
    Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type.
    labelFilter List<String>
    The labels that the BusinessMetric is filtered by within a particular CostReport.
    labelFilters Map<String,List<String>>
    The ClickHouse BusinessMetric label filters applied within a CostReport. Each key is required and values within a key are alternatives.
    unitScale String
    Determines the scale of the BusinessMetric's values within a particular CostReport.
    calculationType string
    The calculation type applied when this BusinessMetric is used in the CostReport.
    costReportToken string
    The token of the CostReport the BusinessMetric is attached to.
    label string
    Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type.
    labelFilter string[]
    The labels that the BusinessMetric is filtered by within a particular CostReport.
    labelFilters {[key: string]: string[]}
    The ClickHouse BusinessMetric label filters applied within a CostReport. Each key is required and values within a key are alternatives.
    unitScale string
    Determines the scale of the BusinessMetric's values within a particular CostReport.
    calculation_type str
    The calculation type applied when this BusinessMetric is used in the CostReport.
    cost_report_token str
    The token of the CostReport the BusinessMetric is attached to.
    label str
    Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type.
    label_filter Sequence[str]
    The labels that the BusinessMetric is filtered by within a particular CostReport.
    label_filters Mapping[str, Sequence[str]]
    The ClickHouse BusinessMetric label filters applied within a CostReport. Each key is required and values within a key are alternatives.
    unit_scale str
    Determines the scale of the BusinessMetric's values within a particular CostReport.
    calculationType String
    The calculation type applied when this BusinessMetric is used in the CostReport.
    costReportToken String
    The token of the CostReport the BusinessMetric is attached to.
    label String
    Optional custom display name for this BusinessMetric on the CostReport. When omitted, a default is derived from the calculation type.
    labelFilter List<String>
    The labels that the BusinessMetric is filtered by within a particular CostReport.
    labelFilters Map<List<String>>
    The ClickHouse BusinessMetric label filters applied within a CostReport. Each key is required and values within a key are alternatives.
    unitScale String
    Determines the scale of the BusinessMetric's values within a particular CostReport.

    GetBusinessMetricsBusinessMetricDatadogMetricFields

    Query string
    The query used to import Datadog metrics.
    Query string
    The query used to import Datadog metrics.
    query string
    The query used to import Datadog metrics.
    query String
    The query used to import Datadog metrics.
    query string
    The query used to import Datadog metrics.
    query str
    The query used to import Datadog metrics.
    query String
    The query used to import Datadog metrics.

    GetBusinessMetricsBusinessMetricGcpBigqueryMetricFields

    QueryProjectId string
    The GCP project in which the BigQuery job runs.
    SqlQuery string
    The SQL query used to import GCP BigQuery metrics.
    QueryProjectId string
    The GCP project in which the BigQuery job runs.
    SqlQuery string
    The SQL query used to import GCP BigQuery metrics.
    query_project_id string
    The GCP project in which the BigQuery job runs.
    sql_query string
    The SQL query used to import GCP BigQuery metrics.
    queryProjectId String
    The GCP project in which the BigQuery job runs.
    sqlQuery String
    The SQL query used to import GCP BigQuery metrics.
    queryProjectId string
    The GCP project in which the BigQuery job runs.
    sqlQuery string
    The SQL query used to import GCP BigQuery metrics.
    query_project_id str
    The GCP project in which the BigQuery job runs.
    sql_query str
    The SQL query used to import GCP BigQuery metrics.
    queryProjectId String
    The GCP project in which the BigQuery job runs.
    sqlQuery String
    The SQL query used to import GCP BigQuery metrics.

    GetBusinessMetricsBusinessMetricMetronomeMetricFields

    BillableMetricId string
    Metronome billable metric UUID for usage metrics.
    BillableMetricName string
    Metronome billable metric display name for usage metrics.
    Metric string
    The selected Metronome metric.
    MetricKind string
    Metronome metric kind.
    BillableMetricId string
    Metronome billable metric UUID for usage metrics.
    BillableMetricName string
    Metronome billable metric display name for usage metrics.
    Metric string
    The selected Metronome metric.
    MetricKind string
    Metronome metric kind.
    billable_metric_id string
    Metronome billable metric UUID for usage metrics.
    billable_metric_name string
    Metronome billable metric display name for usage metrics.
    metric string
    The selected Metronome metric.
    metric_kind string
    Metronome metric kind.
    billableMetricId String
    Metronome billable metric UUID for usage metrics.
    billableMetricName String
    Metronome billable metric display name for usage metrics.
    metric String
    The selected Metronome metric.
    metricKind String
    Metronome metric kind.
    billableMetricId string
    Metronome billable metric UUID for usage metrics.
    billableMetricName string
    Metronome billable metric display name for usage metrics.
    metric string
    The selected Metronome metric.
    metricKind string
    Metronome metric kind.
    billable_metric_id str
    Metronome billable metric UUID for usage metrics.
    billable_metric_name str
    Metronome billable metric display name for usage metrics.
    metric str
    The selected Metronome metric.
    metric_kind str
    Metronome metric kind.
    billableMetricId String
    Metronome billable metric UUID for usage metrics.
    billableMetricName String
    Metronome billable metric display name for usage metrics.
    metric String
    The selected Metronome metric.
    metricKind String
    Metronome metric kind.

    GetBusinessMetricsBusinessMetricSnowflakeMetricFields

    SqlQuery string
    The SQL query used to import Snowflake metrics.
    SqlQuery string
    The SQL query used to import Snowflake metrics.
    sql_query string
    The SQL query used to import Snowflake metrics.
    sqlQuery String
    The SQL query used to import Snowflake metrics.
    sqlQuery string
    The SQL query used to import Snowflake metrics.
    sql_query str
    The SQL query used to import Snowflake metrics.
    sqlQuery String
    The SQL query used to import Snowflake metrics.

    Package Details

    Repository
    vantage vantage-sh/terraform-provider-vantage
    License
    Notes
    This Pulumi package is based on the vantage Terraform Provider.
    vantage
    Viewing docs for vantage 0.4.4
    published on Monday, Oct 26, 2026 by vantage-sh
    Schema (JSON)
    vantage-sh/terraform-provider-vantage

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial