Create a new monitor

5 min

Create a new monitor base information

POST

https://api-sandbox.klavi.ai/monitor/v1/monitors

Header Parameters

Authorizationstringrequired
Description
Bearer access token, it returned by the /auth

Body Parameters

namestringrequired
Description
Name of the monitor
onlineStatusbooleanrequired
Description
Monitor status: true/false
monitorWeekDaysarrayrequired
Description
Monitoring dates within a week: ["MON","TUE","WED","THU","FRI","SAT","SUN"]
monitorFrequencynumberrequired
Description
Daily monitoring frequency: [1, 2]
notificationEmailsarray
Description
Mailing list for sending notifications, the mail must be created in advance in the Klavi Console
ruleobjectrequired
Description
Monitor rule
- relationstring
  Description
  The elements in the list currently only support and
- childrenarray
  Description
  Field List
resultDeliveriesobject
Description
Configure the method for receiving data.
- eventobject
  Description
  Requires partner to provide webhook for event reception.
  - webhookstringrequired
    Description
    http address.
  - headersarray
    Description
    http request header.
- sftpstring
  Description
  Require partner to provide the FTP address for receiving data, format: sftp://username:password@hostname:port
  - hostnamestringrequired
  - portnumberrequired
  - usernamestringrequired
  - passwordstringrequired

Response

idstring
Description
ID of the monitor
presignedUrlstring
Description
Used for uploading user list files

curl

curl --location 'https://api-sandbox.klavi.ai/monitor/v1/monitors' \
--header 'Authorization: string' \
--data '{"name":"String","onlineStatus":"Number","monitorWeekDay":"Array","monitorTimes":"Number","notificationEmails":"Array","rules":"Object","resultDeliveries":"Object"}'

nodejs

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://api-sandbox.klavi.ai/monitor/v1/monitors',
   'headers': {
      'Authorization': 'string'
   },
   body: '{"name":"String","onlineStatus":"Number","monitorWeekDay":"Array","monitorTimes":"Number","notificationEmails":"Array","rules":"Object","resultDeliveries":"Object"}'

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

javascript

var myHeaders = new Headers();
myHeaders.append("Authorization", "string");

var raw = "{\"name\":\"String\",\"onlineStatus\":\"Number\",\"monitorWeekDay\":\"Array\",\"monitorTimes\":\"Number\",\"notificationEmails\":\"Array\",\"rules\":\"Object\",\"resultDeliveries\":\"Object\"}";

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api-sandbox.klavi.ai/monitor/v1/monitors", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

python

import requests

url = "https://api-sandbox.klavi.ai/monitor/v1/monitors"

payload = "{\"name\":\"String\",\"onlineStatus\":\"Number\",\"monitorWeekDay\":\"Array\",\"monitorTimes\":\"Number\",\"notificationEmails\":\"Array\",\"rules\":\"Object\",\"resultDeliveries\":\"Object\"}"
headers = {
   'Authorization': 'string'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

ruby

require "uri"
require "net/http"

url = URI("https://api-sandbox.klavi.ai/monitor/v1/monitors")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = "string"
request.body = "{\"name\":\"String\",\"onlineStatus\":\"Number\",\"monitorWeekDay\":\"Array\",\"monitorTimes\":\"Number\",\"notificationEmails\":\"Array\",\"rules\":\"Object\",\"resultDeliveries\":\"Object\"}"

response = https.request(request)
puts response.read_body

200

{
  "id": "64a8c71f-71db-4972-82b1-1aadc5434dd8"
}

Parameter

children

field

Currently only supports monitoring balance related indicators, including: BALANCE_AMOUNT and BALANCE_INCREASE.

operator

Comparison operator, currently only supports >=, !=.

value

Amount, numeric type.

rule

field	operator	value
BALANCE_AMOUNT	>=, !=	If operator is equal to >=, then value can only be a number. If operator is equal to !=, then value can only be null.
BALANCE_INCREASE	>=	Only numbers.

{
    "onlineStatus": false,
    "name": "monitor-test",
    "monitorFrequency": 1,
    "monitorWeekDays":
    [
        "MON",
        "TUE",
        "WED",
        "THU",
        "FRI",
        "SAT",
        "SUN"
    ],
    "rule":
    {
        "relation": "and",
        "children":
        [
            {
                "field": "BALANCE_INCREASE",
                "value": 12.23,
                "operator": ">="
            },
            {
                "field": "BALANCE_AMOUNT",
                "value": 10,
                "operator": ">="
            }
        ]
    },
    "resultDeliveries":
    {
        "event":
        {
            "webhook": "https://client.webhook.com",
            "headers":
            [
                {
                    "key": "key",
                    "value": "value"
                }
            ]
        }
    }
}

Create a new monitor

Parameter

children

field

operator

value

rule

Body example