List metric watches on an artifact

GET

/v1/metric-watch

const url = 'https://shareout.site/v1/metric-watch?artifact_id=example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://shareout.site/v1/metric-watch?artifact_id=example' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Query Parameters

artifact_id

required

string

Responses

200

Watches for the artifact

application/json

object

watches

Array

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

string

workspace_id

string

nullable

table_name

string

metric_kind

string

column_name

string

last_value

number

nullable

enabled

boolean

created_at

integer

Example

{
  "watches": [
    {
      "kind": "count",
      "threshold_pct": 20
    }
  ]
}

401

Authentication required

application/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"
    ]
  }
}