Get Alerts
curl --request GET \
--url https://api.getmaxim.ai/v1/alerts \
--header 'x-maxim-api-key: <api-key>'import requests
url = "https://api.getmaxim.ai/v1/alerts"
headers = {"x-maxim-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-maxim-api-key': '<api-key>'}};
fetch('https://api.getmaxim.ai/v1/alerts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getmaxim.ai/v1/alerts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-maxim-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.getmaxim.ai/v1/alerts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-maxim-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getmaxim.ai/v1/alerts")
.header("x-maxim-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmaxim.ai/v1/alerts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-maxim-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"workspaceId": "<string>",
"entityId": "<string>",
"type": "<string>",
"enabled": true,
"config": {
"metric": "<string>",
"minimumThreshold": 2,
"duration": 123,
"operator": "<string>",
"value": "<string>",
"renotifyTTL": -1
},
"createdAt": "<string>",
"updatedAt": "<string>",
"notificationChannels": [
{
"notificationChannel": {
"id": "<string>",
"name": "<string>",
"config": {}
}
}
]
}
],
"pagination": {
"cursor": "<string>",
"hasMore": true
}
}Alert
Get Alerts
Get alerts for a workspace
GET
/
v1
/
alerts
Get Alerts
curl --request GET \
--url https://api.getmaxim.ai/v1/alerts \
--header 'x-maxim-api-key: <api-key>'import requests
url = "https://api.getmaxim.ai/v1/alerts"
headers = {"x-maxim-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-maxim-api-key': '<api-key>'}};
fetch('https://api.getmaxim.ai/v1/alerts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.getmaxim.ai/v1/alerts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-maxim-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.getmaxim.ai/v1/alerts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-maxim-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.getmaxim.ai/v1/alerts")
.header("x-maxim-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getmaxim.ai/v1/alerts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-maxim-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"workspaceId": "<string>",
"entityId": "<string>",
"type": "<string>",
"enabled": true,
"config": {
"metric": "<string>",
"minimumThreshold": 2,
"duration": 123,
"operator": "<string>",
"value": "<string>",
"renotifyTTL": -1
},
"createdAt": "<string>",
"updatedAt": "<string>",
"notificationChannels": [
{
"notificationChannel": {
"id": "<string>",
"name": "<string>",
"config": {}
}
}
]
}
],
"pagination": {
"cursor": "<string>",
"hasMore": true
}
}Authorizations
API key for authentication
Query Parameters
Unique identifier for the alert
Unique identifier for the workspace
Minimum string length:
1ID of the entity associated with the alert
Maximum number of records to return (max: 100)
Required range:
x <= 100Cursor for pagination
Was this page helpful?
⌘I