API Reference

Validate a metric configuration

get
https://app.bigeye.com/api/v1/metrics/validation
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
string
enum
Defaults to UNDEFINED_TIME_INTERVAL_TYPE
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
int32
int32

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

string
enum
Defaults to UNDEFINED_PREDEFINED_METRIC_NAME
int32
string
enum
Defaults to UNDEFINED_AGGREGATION_TYPE
Allowed:
string
string
enum
Defaults to EXTERNAL_MONITOR_TYPE_UNDEFINED
Allowed:
string
enum
Defaults to CUSTOM_RULE_TYPE_UNSPECIFIED
Allowed:
boolean
boolean
string
enum
Defaults to UNDEFINED_TIME_INTERVAL_TYPE
int32
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:
string
enum
Defaults to METRIC_CREATION_STATE_UNSPECIFIED
int32

width of METRIC_TIME based metric intervals.

string
string
string
boolean
string
enum
Defaults to UNDEFINED_TIME_INTERVAL_TYPE
int32
int32
string
string
int32
string
int32
string
string

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

string
boolean
string
int32
string
int32
string
string
enum
Defaults to MONITOR_TYPE_UNDEFINED
Allowed:
boolean
int32
boolean

When set, overrides the advanced settings for whether the latest data point is included in the
data time window query. If not set, the advanced settings are used.

Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?