Update a custom rule

put

https://app.bigeye.com/api/v1/custom-rules/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

Body Params

bigconfigNamespace

string

The Bigconfig namespace that owns this rule, if any. Output-only.

collectionIds

array of int32s

collectionIds

customRuleType

string

enum

Defaults to CUSTOM_RULE_TYPE_UNSPECIFIED

Allowed:

description

string

dimension

object

isBigconfig

boolean

True when this rule is managed by a Bigconfig suite. Output-only: set by the backend
from the backing metric's creation state; ignored on input.

join

object

joinType

string

enum

Defaults to JOIN_TYPE_UNSPECIFIED

Allowed:

leftAlias

string

leftSelectColumns

array of objects

leftSelectColumns

lowerThreshold

double

metricObservedColumnResponse

array of objects

metricObservedColumnResponse

metricSchedule

object

name

string

observedColumns

array of strings

Fully-qualified column names this rule observes (e.g. source.schema.table.column). Used as
Bigconfig suite input to link the rule to assets; resolved to dataset fields on apply.

observedColumns

owner

object

profilingSuggestionForColumn

object

profilingSuggestionForCorrelatedColumns

object

rightAlias

string

rightSelectColumns

array of objects

rightSelectColumns

sql

string

200A successful response.

defaultAn unexpected error response.