Create a new monitor

5min
Create a new monitor base information
POST
Request
Response
Header Parameters
Authorization
String
required
Bearer access token, it returned by the /auth
Body Parameters
name
String
required
Name of the monitor
onlineStatus
Boolean
required
Monitor status: true/false
monitorWeekDays
Array
required
Monitoring dates within a week:  ["MON","TUE","WED","THU","FRI","SAT","SUN"]
monitorFrequency
Number
required
Daily monitoring frequency: [1, 2]
notificationEmails
Array
optional
Mailing list for sending notifications, the mail must be created in advance in the Klavi Console
rule
Object
required
Monitor rule
resultDeliveries
Object
optional
Configure the method for receiving data.
Curl
Node.js
JS
Python
Ruby
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"}'
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"}'
Responses
200
{
  "id": "64a8c71f-71db-4972-82b1-1aadc5434dd8"
}
{
  "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.
﻿
JSON
{
    "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"
                }
            ]
        }
    }
}
{
    "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"
                }
            ]
        }
    }
}
﻿
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.
Refresh Access Token
Get all monitors
Create a new monitor

Parameter

children

field

operator

value

rule

Body example
