> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vantage.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# vantage_business_metric (Resource)

> Terraform resource reference for vantage_business_metric (Resource). Auto-generated from the vantage-sh/terraform-provider-vantage repository.

<Note>
  This page is auto-generated based on the official [Terraform documentation](https://registry.terraform.io/providers/vantage-sh/vantage/latest/docs).
</Note>

## Overview

Use this resource with the [Vantage Terraform provider](/terraform). For installation and authentication, see the [Terraform provider quickstart](/terraform#quickstart). The schema below is generated directly from the provider source.

## Schema

### Required

* `title` (String) The title of the BusinessMetrics.

### Optional

* `clickhouse_metric_fields` (Attributes) ClickHouse metric configuration fields. Changing this block replaces the business metric. (see [below for nested schema](#nestedatt--clickhouse_metric_fields))
* `cloudwatch_fields` (Attributes) Cloudwatch configuration fields. (see [below for nested schema](#nestedatt--cloudwatch_fields))
* `cost_report_tokens_with_metadata` (Attributes List) The tokens for any CostReports that use the BusinessMetric, the unit scale, and label filter. (see [below for nested schema](#nestedatt--cost_report_tokens_with_metadata))
* `datadog_metric_fields` (Attributes) Datadog metric configuration fields (see [below for nested schema](#nestedatt--datadog_metric_fields))
* `forecasted_values` (Attributes List) The dates, amounts, and (optional) labels for forecasted BusinessMetric values. (see [below for nested schema](#nestedatt--forecasted_values))
* `gcp_bigquery_metric_fields` (Attributes) GCP BigQuery metric configuration fields. Changing this block replaces the business metric. (see [below for nested schema](#nestedatt--gcp_bigquery_metric_fields))
* `snowflake_metric_fields` (Attributes) Snowflake metric configuration fields. (see [below for nested schema](#nestedatt--snowflake_metric_fields))
* `values` (Attributes List) The dates, amounts, and (optional) labels for the BusinessMetric. (see [below for nested schema](#nestedatt--values))

### Read-Only

* `created_by_token` (String) The token of the Creator of the BusinessMetric.
* `id` (String) The id of the business metric
* `import_type` (String) The type of import for the BusinessMetric.
* `integration_token` (String) The Integration token used to import the BusinessMetric.
* `token` (String) The token of the business metric

<a id="nestedatt--clickhouse_metric_fields" />

### Nested Schema for `clickhouse_metric_fields`

Optional:

* `integration_token` (String) Integration token for the ClickHouse integration from which you would like to fetch metrics.
* `query_endpoint_id` (String) UUID of the ClickHouse query endpoint used to fetch metrics.

<a id="nestedatt--cloudwatch_fields" />

### Nested Schema for `cloudwatch_fields`

Optional:

* `dimensions` (Attributes List) The dimensions used to pull specific statistical data for Cloudwatch metrics. (see [below for nested schema](#nestedatt--cloudwatch_fields--dimensions))
* `integration_token` (String) Integration token for the account from which you would like to fetch 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.

<a id="nestedatt--cloudwatch_fields--dimensions" />

### Nested Schema for `cloudwatch_fields.dimensions`

Optional:

* `name` (String)
* `value` (String)

<a id="nestedatt--cost_report_tokens_with_metadata" />

### Nested Schema for `cost_report_tokens_with_metadata`

Required:

* `cost_report_token` (String) The token of the CostReport the BusinessMetric is attached to.

Optional:

* `calculation_type` (String) The calculation type applied when this BusinessMetric is used in the CostReport.
* `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 of String) Include only values with these labels in the CostReport.
* `label_filters` (Map of List of String) Include only ClickHouse BusinessMetric values matching every label key and one of its values.
* `unit_scale` (String) Determines the scale of the BusinessMetric's values within the CostReport.

<a id="nestedatt--datadog_metric_fields" />

### Nested Schema for `datadog_metric_fields`

Optional:

* `integration_token` (String) Integration token for the account from which you would like to fetch metrics.
* `query` (String) Datadog metrics query string. e.g. `sum:aws.applicationelb.request_count{region:us-east-1}.rollup(avg,daily)`

<a id="nestedatt--forecasted_values" />

### Nested Schema for `forecasted_values`

Required:

* `amount` (Number)
* `date` (String)

Optional:

* `label` (String)

<a id="nestedatt--gcp_bigquery_metric_fields" />

### Nested Schema for `gcp_bigquery_metric_fields`

Optional:

* `integration_token` (String) Integration token for the GCP integration from which you would like to fetch metrics.
* `query_project_id` (String) GCP project in which the BigQuery job should run.
* `sql_query` (String) BigQuery SQL query returning date, value, and optional label columns.

<a id="nestedatt--snowflake_metric_fields" />

### Nested Schema for `snowflake_metric_fields`

Optional:

* `integration_token` (String) Integration token for the Snowflake integration from which you would like to fetch metrics.
* `sql_query` (String) Snowflake SQL query returning date, value, and optional label columns.

<a id="nestedatt--values" />

### Nested Schema for `values`

Required:

* `amount` (Number)
* `date` (String)

Optional:

* `label` (String)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.