List alert rules

GET

/v1/metric-alerts

const url = 'https://shareout.site/v1/metric-alerts?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-alerts?artifact_id=example' \
  --header 'Authorization: Bearer <token>'

Manager-aware — managers see every rule on the artifact; viewers see only their own.

Authorizations

bearerAuth

Parameters

Query Parameters

artifact_id

required

string

Responses

200

Alert rules

application/json

object

alerts

Array

object

artifact_id

required

string

metric_id

required

string

name

required

string

condition

required

object

required

string

Allowed values: gt gte lt lte eq neq

value

required

number

schedule

required

5-field cron expression.

string

destination

required

object

kind

required

string

Allowed values: slack email discord webhook http_get telegram

config

required

Destination config matching the kind (see Jobs config interfaces).

object

message

string

cooldown_seconds

integer

string

enabled

boolean

created_at

integer

Example

{
  "alerts": [
    {
      "condition": {
        "op": "gt"
      },
      "destination": {
        "kind": "slack"
      }
    }
  ]
}