cURL
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
API key for authentication
Unique identifier for the alert
Unique identifier for the workspace
1
ID of the entity associated with the alert
Maximum number of records to return (max: 100)
x <= 100
Cursor for pagination
Alerts retrieved successfully
Show child attributes
Metric to monitor
Minimum threshold for the alert
x >= 1
Duration must be one of: 60, 300, 600, 1800, 3600 or 86400 (seconds)
Comparison operator for the alert condition
Value to compare against
Time to live for renotification in seconds. -1 means no TTL
Unique identifier for the notification channel
Type of notification channel.
SLACK
PAGER_DUTY
Name of the notification channel
Channel-specific configuration
Was this page helpful?