Skip to content

Create a metric watch

POST
/v1/metric-watch
curl --request POST \
--url https://shareout.site/v1/metric-watch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "artifact_id": "example", "table": "example", "kind": "count", "column": "example", "threshold_pct": 20 }'

One-click table watch — bell-only anomaly alerts (±threshold_pct vs baseline).

Media typeapplication/json
object
artifact_id
required
string
table
required
string
kind
required
string
Allowed values: count sum last
column

Required for sum and last.

string
threshold_pct

Alert when value moves ±this percent from baseline.

number
default: 20

Watch created

Media typeapplication/json
object
watch
object
artifact_id
required
string
table
required
string
kind
required
string
Allowed values: count sum last
column

Required for sum and last.

string
threshold_pct

Alert when value moves ±this percent from baseline.

number
default: 20
id
string
workspace_id
string
nullable
table_name
string
metric_kind
string
column_name
string
last_value
number
nullable
enabled
boolean
created_at
integer
Example
{
"watch": {
"kind": "count",
"threshold_pct": 20
}
}

Invalid request

Media typeapplication/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string
reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string
hint

What to do next, in plain words.

string
suggestion
string
param

The request field at fault.

string
docs

Doc page for this error.

string
redirect_url
string
support

Present on 5xx — how to reach a human.

object
how
string
include
Array<string>
Example
{
"success": false,
"support": {
"how": "POST /v1/support/tickets",
"include": [
"request_id"
]
}
}

Authentication required

Media typeapplication/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string
reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string
hint

What to do next, in plain words.

string
suggestion
string
param

The request field at fault.

string
docs

Doc page for this error.

string
redirect_url
string
support

Present on 5xx — how to reach a human.

object
how
string
include
Array<string>
Example
{
"success": false,
"support": {
"how": "POST /v1/support/tickets",
"include": [
"request_id"
]
}
}