Validate a metric configuration

get

https://app.bigeye.com/api/v1/metrics/validation

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

int32

scheduleFrequency.IntervalType

string

enum

Defaults to UNDEFINED_TIME_INTERVAL_TYPE

scheduleFrequency.IntervalValue

int32

filters

array of strings

Each filter evaluates to a valid SQL boolean expression.

filters

groupBys

array of strings

Each group by is a column name from the table for this metric.

groupBys

warehouseId

int32

datasetId

int32

Bigeye ID for the table which this metric is run on.

metricType.PredefinedMetric.MetricName

string

enum

Defaults to UNDEFINED_PREDEFINED_METRIC_NAME

metricType.TemplateMetric.TemplateId

int32

metricType.TemplateMetric.AggregationType

string

enum

Defaults to UNDEFINED_AGGREGATION_TYPE

Allowed:

metricType.TemplateMetric.TemplateName

string

metricType.ExternalMonitor.Type

string

enum

Defaults to EXTERNAL_MONITOR_TYPE_UNDEFINED

Allowed:

metricType.CustomRuleType

string

enum

Defaults to CUSTOM_RULE_TYPE_UNSPECIFIED

Allowed:

metricType.IsMetadataMetric

boolean

metricType.IsTableMetric

boolean

lookback.intervalType

string

enum

Defaults to UNDEFINED_TIME_INTERVAL_TYPE

lookback.intervalValue

int32

lookbackType

string

enum

Defaults to UNDEFINED_LOOKBACK_TYPE

Lookback type for metrics on tables with metric time enabled. The default is DATA_TIME_LOOKBACK_TYPE.

Allowed:

metricCreationState

string

enum

Defaults to METRIC_CREATION_STATE_UNSPECIFIED

grainSeconds

int32

width of METRIC_TIME based metric intervals.

mutedUntilEpochSeconds

string

name

string

description

string

isTableMetric

boolean

metricSchedule.ScheduleFrequency.IntervalType

string

enum

Defaults to UNDEFINED_TIME_INTERVAL_TYPE

metricSchedule.ScheduleFrequency.IntervalValue

int32

metricSchedule.NamedSchedule.Id

int32

metricSchedule.NamedSchedule.Name

string

metricSchedule.NamedSchedule.Cron

string

metricSchedule.NamedSchedule.EntityInfo.CreatedBy

int32

metricSchedule.NamedSchedule.EntityInfo.CreatedEpochSeconds

string

metricSchedule.NamedSchedule.EntityInfo.UpdatedBy

int32

metricSchedule.NamedSchedule.EntityInfo.UpdatedEpochSeconds

string

metricSchedule.NamedSchedule.Timezone

string

IANA timezone id (e.g. "America/New_York") used to interpret the cron. Defaults to UTC when unset.

rctOverride

string

isLookbackUsingCurrentTime

boolean

bigconfigNamespace

string

dimension.id

int32

dimension.displayName

string

profilingSuggestionForColumn.Id

int32

profilingSuggestionForColumn.DisplayName

string

monitorType

string

enum

Defaults to MONITOR_TYPE_UNDEFINED

Allowed:

alertOnAbsentGroups

boolean

customRuleId

int32

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.

defaultAn unexpected error response.