API REFERENCE
Monitors base info
Get all monitors
1 min
{ "name" "get all monitors", "method" "get", "url" "https //api sandbox klavi ai/monitor/v1/monitors", "description" "get all base informations of monitors ", "tab" "examples", "examples" { "languages" \[ { "id" "ux6ft5l1hw1ecwdaluezu", "language" "curl", "code" "curl location 'https //api sandbox klavi ai/monitor/v1/monitors?onlinestatus=string\&userliststatus=string' \\\\\n header 'authorization string'", "customlabel" "" }, { "id" "hx6hcyas4cwkclywhcoc3", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' 'https //api sandbox klavi ai/monitor/v1/monitors?onlinestatus=string\&userliststatus=string',\n 'headers' {\n 'authorization' 'string'\n }\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "i xyjeckgz8shp4gzeeen", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"authorization\\", \\"string\\");\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(\\"https //api sandbox klavi ai/monitor/v1/monitors?onlinestatus=string\&userliststatus=string\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "sxheni7ttzdqnktwvja5i", "language" "python", "code" "import requests\n\nurl = \\"https //api sandbox klavi ai/monitor/v1/monitors?onlinestatus=string\&userliststatus=string\\"\n\npayload = {}\nheaders = {\n 'authorization' 'string'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "m7vlrec py2zweu4jkpq3", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"net/http\"\n\nurl = uri(\\"https //api sandbox klavi ai/monitor/v1/monitors?onlinestatus=string\&userliststatus=string\\")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http get new(url)\nrequest\[\\"authorization\\"] = \\"string\\"\n\nresponse = https request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "ux6ft5l1hw1ecwdaluezu" }, "results" { "languages" \[ { "id" "lswnhudfaydnjplgsrwyv", "language" "200", "customlabel" "", "code" "\[\n {\n \\"id\\" \\"64a8c71f 71db 4972 82b1 1aadc5434dd8\\",\n \\"name\\" \\"monitore teste 150 20250320\\",\n \\"onlinestatus\\" true,\n \\"userliststatus\\" \\"awaiting upload\\",\n \\"monitorweekdays\\" \[\\"mon\\",\\"tue\\",\\"wed\\",\\"thu\\",\\"fri\\",\\"sat\\"],\n \\"monitorfrequency\\" 2,\n \\"notificationemails\\" \[\\"admin\@partner com\\"],\n \\"createat\\" \\"2025 03 20t19 03 59z\\",\n \\"updateat\\" \\"2025 03 20t19 03 59z\\"\n }\n]" } ], "selectedlanguageid" "lswnhudfaydnjplgsrwyv" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "onlinestatus", "kind" "optional", "type" "boolean", "description" "monitor status true/false, if not pass this parameter, return all monitors", "" "monitor status true/false, if not pass this parameter, return all monitors" }, { "name" "userliststatus", "kind" "optional", "type" "string", "description" "user list file upload status awaiting upload/uploaded, if not pass this parameter, return all monitors", "" "user list file upload status awaiting upload/uploaded, if not pass this parameter, return all monitors" } ], "headerparameters" \[ { "name" "authorization", "kind" "required", "type" "string", "description" "bearer access token, it returned by the /auth", "" "required" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" }, "hastryitout" false, "response" \[ { "name" "id", "kind" "optional", "type" "string", "description" "id of the monitor" }, { "name" "name", "kind" "optional", "type" "string", "description" "name of the monitor", "children" \[] }, { "name" "onlinestatus", "kind" "optional", "type" "string", "description" "monitor status online/offline", "children" \[] }, { "name" "userliststatus", "kind" "optional", "type" "string", "description" "user list status awaiting upload/uploaded", "children" \[] }, { "name" "monitorweekdays", "kind" "optional", "type" "array", "description" "monitoring dates within a week \[\\"mon\\",\\"tue\\",\\"wed\\",\\"thu\\",\\"fri\\",\\"sat\\"]", "children" \[] }, { "name" "monitortimes", "kind" "optional", "type" "integer", "description" "daily monitoring frequency", "children" \[] }, { "name" "notificationemails", "kind" "optional", "type" "array", "description" "mailing list for sending notifications, the mail must be created in advance in the klavi console", "children" \[] }, { "name" "createat", "kind" "optional", "type" "string", "description" "create time", "children" \[] }, { "name" "updateat", "kind" "optional", "type" "string", "description" "update time", "children" \[] } ] }