# ChartMetadata
**Source definition:** [`src/bitdrift/public/unary/charts/v1/chart_metadata.proto#L14-L184`]()
| Field | Type | Description |
|---|---|---|
| title | string
up to 255 chars | The title of the chart to be displayed. |
| summary | optional [bitdrift.public.unary.charts.v1.ChartMetadata.Summary](#bitdrift.public.unary.charts.v1.ChartMetadata.Summary "bitdrift.public.unary.charts.v1.ChartMetadata.Summary") | An optional piece of summary information to display alongside the chart. |
| no_data_message | optional string
up to 500 chars | An optional message to display when there is no data available for the chart. If not set use the default message. |
| metric_chart_metadata | [bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata](#bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata "bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata")only one of metric_chart_metadata, or funnel_chart_metadata, flush_chart_metadata, sankey_chart_metadata can be set | Metadata for metric-based charts such as time series, tables, and histograms. |
| funnel_chart_metadata | [bitdrift.public.unary.charts.v1.ChartMetadata.FunnelChartMetadata](#bitdrift.public.unary.charts.v1.ChartMetadata.FunnelChartMetadata "bitdrift.public.unary.charts.v1.ChartMetadata.FunnelChartMetadata")only one of funnel_chart_metadata, or metric_chart_metadata, flush_chart_metadata, sankey_chart_metadata can be set | Metadata for funnel charts. |
| flush_chart_metadata | [bitdrift.public.unary.charts.v1.ChartMetadata.FlushChartMetadata](#bitdrift.public.unary.charts.v1.ChartMetadata.FlushChartMetadata "bitdrift.public.unary.charts.v1.ChartMetadata.FlushChartMetadata")only one of flush_chart_metadata, or metric_chart_metadata, funnel_chart_metadata, sankey_chart_metadata can be set | Metadata for session capture flush charts. |
| sankey_chart_metadata | [bitdrift.public.unary.charts.v1.ChartMetadata.SankeyChartMetadata](#bitdrift.public.unary.charts.v1.ChartMetadata.SankeyChartMetadata "bitdrift.public.unary.charts.v1.ChartMetadata.SankeyChartMetadata")only one of sankey_chart_metadata, or metric_chart_metadata, funnel_chart_metadata, flush_chart_metadata can be set | Metadata for sankey charts. |
Example
```json
{
"metric_chart_metadata": {
"metadata": [
{
"connector_export_config": [
{
"cloudwatch_connector_export_config": {
"fixed_dimensions": {
"key": ""
},
"metric_name": "foreground_launches",
"namespace": "mobile_metrics"
},
"connector_name": "cloudwatch-primary"
}
],
"limit_strategy": {
"exclusions": {
"dimension_identifiers": [
{
"id": "time_series_id_opaque_example",
"labels": [
{
"name": "name",
"value": "value"
}
]
}
],
"return_other": false
},
"sort_order": "MAX",
"top_k_limit": {
"top_k": 5
}
},
"sort_order": "DESC",
"title": "Time series title",
"top_k_algorithm": "MAX",
"y_axis": {
"description": "Count",
"unit": "COUNT"
}
}
],
"time_series_display_mode": {}
},
"no_data_message": "Example text",
"summary": {
"description": "Example text"
},
"title": "Chart title"
}
```
# ChartMetadata.FlushChartMetadata
**Source definition:** [`src/bitdrift/public/unary/charts/v1/chart_metadata.proto#L15-L16`]()
No fields
# ChartMetadata.SankeyChartMetadata
**Source definition:** [`src/bitdrift/public/unary/charts/v1/chart_metadata.proto#L18-L19`]()
No fields
# ChartMetadata.MetricChartMetadata
**Source definition:** [`src/bitdrift/public/unary/charts/v1/chart_metadata.proto#L21-L141`]()
| Field | Type | Description |
|---|---|---|
| time_series_display_mode | [bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesDisplayMode](#bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesDisplayMode "bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesDisplayMode")only one of time_series_display_mode, or table_display_mode, histogram_bar_chart_display_mode can be set | Displays the chart as a time series visualization. |
| table_display_mode | [bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TableDisplayMode](#bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TableDisplayMode "bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TableDisplayMode")only one of table_display_mode, or time_series_display_mode, histogram_bar_chart_display_mode can be set | Displays the chart as a table. |
| histogram_bar_chart_display_mode | [bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.HistogramBarChartDisplayMode](#bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.HistogramBarChartDisplayMode "bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.HistogramBarChartDisplayMode")only one of histogram_bar_chart_display_mode, or time_series_display_mode, table_display_mode can be set | Displays histogram data as a bar chart. |
| metadata | array of [bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata](#bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata "bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata")
up to 100 items | Metadata for each time series in the chart. The length of this list should match the number of time series in the chart's query. If a time series does not have metadata, provide the default object and defaults will be used. |
Example
```json
{
"metadata": [
{
"connector_export_config": [
{
"cloudwatch_connector_export_config": {
"fixed_dimensions": {
"key": ""
},
"metric_name": "foreground_launches",
"namespace": "mobile_metrics"
},
"connector_name": "cloudwatch-primary"
}
],
"limit_strategy": {
"exclusions": {
"dimension_identifiers": [
{
"id": "time_series_id_opaque_example",
"labels": [
{
"name": "name",
"value": "value"
}
]
}
],
"return_other": false
},
"sort_order": "MAX",
"top_k_limit": {
"top_k": 5
}
},
"sort_order": "DESC",
"title": "Time series title",
"top_k_algorithm": "MAX",
"y_axis": {
"description": "Count",
"unit": "COUNT"
}
}
],
"time_series_display_mode": {}
}
```
# ChartMetadata.MetricChartMetadata.TimeSeriesMetadata
**Source definition:** [`src/bitdrift/public/unary/charts/v1/chart_metadata.proto#L22-L115`]()
| Field | Type | Description |
|---|---|---|
| y_axis | [bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.Axis](#bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.Axis "bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.Axis") | The Y axis of the time series. This is used to format the Y axis of the chart as well as the hover tooltip. |
| title | string
up to 255 chars | The title of the time series. This is used to display the time series in the chart. |
| sort_order | [bitdrift.public.unary.charts.v1.SortOrder](bitdrift_public_unary_charts_v1_SortOrder.md "bitdrift.public.unary.charts.v1.SortOrder")
must be a defined enum value | Determines how the TopK is sorted when performing TopK queries. Defaults to Maximum. |
| limit_strategy | optional [bitdrift.public.unary.charts.v1.LimitStrategy](bitdrift_public_unary_charts_v1_LimitStrategy.md "bitdrift.public.unary.charts.v1.LimitStrategy") | Optional limit strategy to persist for this time series (top K count, dimension selection, sort order). |
| top_k_algorithm | optional [bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.TopKAlgorithm](#bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.TopKAlgorithm "bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.TopKAlgorithm")
must be a defined enum value | The top K algorithm to use for this time series to determine which K time series are selected for group by time series. |
| connector_export_config | array of [bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.ConnectorExportConfig](#bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.ConnectorExportConfig "bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.ConnectorExportConfig")
up to 10 items | Configuration for exporting data to a connector. |
Example
```json
{
"connector_export_config": [
{
"cloudwatch_connector_export_config": {
"fixed_dimensions": {
"key": ""
},
"metric_name": "foreground_launches",
"namespace": "mobile_metrics"
},
"connector_name": "cloudwatch-primary"
}
],
"limit_strategy": {
"exclusions": {
"dimension_identifiers": [
{
"id": "time_series_id_opaque_example",
"labels": [
{
"name": "name",
"value": "value"
}
]
}
],
"return_other": false
},
"sort_order": "MAX",
"top_k_limit": {
"top_k": 5
}
},
"sort_order": "DESC",
"title": "Time series title",
"top_k_algorithm": "MAX",
"y_axis": {
"description": "Count",
"unit": "COUNT"
}
}
```
# ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.Axis
**Source definition:** [`src/bitdrift/public/unary/charts/v1/chart_metadata.proto#L30-L52`]()
| Field | Type | Description |
|---|---|---|
| description | string
up to 255 chars | The description of the axis to display. |
| unit | [bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.Axis.Unit](#bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.Axis.Unit "bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.Axis.Unit")
must be a defined enum value | The unit of the axis. |
Example
```json
{
"description": "Count",
"unit": "COUNT"
}
```
# ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.Axis.Unit Enum
**Source definition:** [`src/bitdrift/public/unary/charts/v1/chart_metadata.proto#L34-L48`]()
| Name | Description |
|---|---|
| UNSPECIFIED | |
| PERCENTAGE | |
| MILLISECONDS | |
| TIMESTAMP | |
| BYTES | |
| COUNT | |
| KILOBYTES | |
| MEGABYTES | |
| SECONDS | |
| MINUTES | |
| HOURS | |
| DAYS | |
| GIGABYTES | |
# ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.ConnectorExportConfig
**Source definition:** [`src/bitdrift/public/unary/charts/v1/chart_metadata.proto#L55-L94`]()
Configuration for exporting data to a connector.
| Field | Type | Description |
|---|---|---|
| connector_name | string
between 1 and 255 chars | The name of the connector to which data will be exported. The connector should have already been added via the AdminService's UpsertConnector method. The connector type must match the type expected by the time series export configuration. |
| cloudwatch_connector_export_config | [bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.ConnectorExportConfig.CloudwatchConnectorExportConfig](#bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.ConnectorExportConfig.CloudwatchConnectorExportConfig "bitdrift.public.unary.charts.v1.ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.ConnectorExportConfig.CloudwatchConnectorExportConfig") | Configuration specific to CloudWatch connectors. CloudWatch export is valid only for counter-backed time series. The configuration fails if the time series uses histogram data. For metrics with a numerator and denominator, the export configuration emits two CloudWatch metrics: one for the numerator and one for the denominator. The supplied metric name is appended with "/numerator" and "/denominator" for the respective metrics. |
Example
```json
{
"cloudwatch_connector_export_config": {
"fixed_dimensions": {
"key": ""
},
"metric_name": "foreground_launches",
"namespace": "mobile_metrics"
},
"connector_name": "cloudwatch-primary"
}
```
# ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.ConnectorExportConfig.CloudwatchConnectorExportConfig
**Source definition:** [`src/bitdrift/public/unary/charts/v1/chart_metadata.proto#L56-L74`]()
| Field | Type | Description |
|---|---|---|
| namespace | string
between 1 and 255 chars | The CloudWatch namespace to which data will be exported. This will be appended to 'bitdrift/'. |
| metric_name | string
between 1 and 255 chars | The CloudWatch metric name to emit within the configured namespace. |
| fixed_dimensions | map
up to 10 entries | A set of fixed dimensions to include with every metric emitted to CloudWatch. These dimensions will be added in addition to any dimensions specified by the time series query. |
Example
```json
{
"fixed_dimensions": {
"key": ""
},
"metric_name": "foreground_launches",
"namespace": "mobile_metrics"
}
```
# ChartMetadata.MetricChartMetadata.TimeSeriesMetadata.TopKAlgorithm Enum
**Source definition:** [`src/bitdrift/public/unary/charts/v1/chart_metadata.proto#L23-L28`]()
| Name | Description |
|---|---|
| TOP_K_ALGORITHM_UNSPECIFIED | |
| TOP_K_ALGORITHM_AVERAGED | |
| TOP_K_ALGORITHM_2TIERED | |
| TOP_K_ALGORITHM_3TIERED | |
# ChartMetadata.MetricChartMetadata.TimeSeriesDisplayMode
**Source definition:** [`src/bitdrift/public/unary/charts/v1/chart_metadata.proto#L117-L118`]()
No fields
# ChartMetadata.MetricChartMetadata.TableDisplayMode
**Source definition:** [`src/bitdrift/public/unary/charts/v1/chart_metadata.proto#L120-L121`]()
No fields
# ChartMetadata.MetricChartMetadata.HistogramBarChartDisplayMode
**Source definition:** [`src/bitdrift/public/unary/charts/v1/chart_metadata.proto#L123-L124`]()
No fields
# ChartMetadata.FunnelChartMetadata
**Source definition:** [`src/bitdrift/public/unary/charts/v1/chart_metadata.proto#L143-L153`]()
| Field | Type | Description |
|---|---|---|
| steps | array of [bitdrift.public.unary.charts.v1.ChartMetadata.FunnelChartMetadata.StepDetail](#bitdrift.public.unary.charts.v1.ChartMetadata.FunnelChartMetadata.StepDetail "bitdrift.public.unary.charts.v1.ChartMetadata.FunnelChartMetadata.StepDetail")
up to 100 items | Extra details pertaining to each step of the funnel. The step details is associated via the index of the array, e.g. the nth element in this array corresponds to the nth step in the funnel. This allows modifying this data without knowing about the server generated IDs. |
Example
```json
{
"steps": [
{
"name": "Step name"
}
]
}
```
# ChartMetadata.FunnelChartMetadata.StepDetail
**Source definition:** [`src/bitdrift/public/unary/charts/v1/chart_metadata.proto#L144-L147`]()
| Field | Type | Description |
|---|---|---|
| name | string
up to 255 chars | The funnel step name. It is used to display the step in the funnel chart. |
Example
```json
{
"name": "Step name"
}
```
# ChartMetadata.Summary
**Source definition:** [`src/bitdrift/public/unary/charts/v1/chart_metadata.proto#L155-L158`]()
| Field | Type | Description |
|---|---|---|
| description | string
up to 500 chars | A description displayed alongside the chart as help text. |
Example
```json
{
"description": "Example text"
}
```