curl --request GET \
--url https://api.getmaxim.ai/v1/alerts \
--header 'x-maxim-api-key: <api-key>'{
"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>",
"type": "SLACK",
"name": "<string>",
"config": {}
}
}
]
}
],
"pagination": {
"cursor": "<string>",
"hasMore": true
}
}Get alerts for a workspace
curl --request GET \
--url https://api.getmaxim.ai/v1/alerts \
--header 'x-maxim-api-key: <api-key>'{
"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>",
"type": "SLACK",
"name": "<string>",
"config": {}
}
}
]
}
],
"pagination": {
"cursor": "<string>",
"hasMore": true
}
}API key for authentication
Unique identifier for the alert
Unique identifier for the workspace
1ID of the entity associated with the alert
Maximum number of records to return (max: 100)
x <= 100Cursor for pagination
Was this page helpful?