API Documentation
API Reference
- Inventory
- Resource
- Monitor
- Incident
- Integration
- Organization
- User
- POSTQuery logs
- POSTQuery metrics
- POSTQuery traces
List all Alerts for a Monitor
curl --request GET \
--url https://api.alerty.ai/monitor/{id}/alert \
--header 'Authorization: Bearer <token>'[
{
"id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"title": "<string>",
"description": "<string>",
"state": "TRIGGED",
"severity": "NOT_DEFINED",
"query": "<string>",
"monitor": {
"id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"pollDurationInterval": "P3Y6M4DT12H30M5S",
"name": "<string>",
"description": "<string>",
"type": "UP_TIME",
"resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"snoozedUntil": "2023-11-07T05:31:56Z",
"state": "ACTIVE",
"status": "NO_DATA",
"priority": "NOT_DEFINED",
"recipients": [
{
"id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"integration": {
"id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"type": "SLACK",
"class": "NOTIFICATION",
"configuration": {
"teamId": "<string>",
"accessToken": "<string>",
"incomingWebhookURL": "<string>",
"channelID": "<string>"
}
},
"integrationOverride": {
"teamId": "<string>",
"accessToken": "<string>",
"incomingWebhookURL": "<string>",
"channelID": "<string>"
}
}
],
"query": "<string>",
"resource": {
"id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"type": "WEBSITE",
"configuration": {
"url": "<string>"
}
}
},
"resolvedAt": "2023-11-07T05:31:56Z",
"resolvedBy": {
"id": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"emailVerified": true,
"profilePictureURL": "<string>"
}
}
]Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
the monitor identifier
Response
Unique identifier for the entity
the alert title
state of the alert during its lifecycle
TRIGGED, RESOLVED alert severity
NOT_DEFINED, CRITICAL, HIGH, MEDIUM, LOW the alert description field
the monitor query
resource monitor
Unique identifier for the entity
the monitor name
the monitor type
UP_TIME, LATENCY, LOAD_TIME, WEBSITE_TYPO, STRIPE, DOMAIN_EXPIRATION, CERT_EXPIRATION, CDN_CONFIGURATION, CLOUDFLARE_REQUESTS, CLOUDFRONT_REQUESTS, STATUS_PAGE, DATABASE_STORAGE_LIMIT, DATABASE_CPU_USAGE, DATABASE_MEMORY_USAGE state of the monitor during its lifecycle
ACTIVE, PAUSED, SNOOZED, ERROR status of the monitor
NO_DATA, OK, ALERT, WARN monitor priority
NOT_DEFINED, CRITICAL, HIGH, MEDIUM, LOW, INFO the monitor recipients of the incidents/alerts notifications
Unique identifier for the entity
the integration information
Unique identifier for the entity
the integration type
SLACK, PAGERDUTY, EMAIL the integration class
NOTIFICATION, CLOUD_PROVIDER the slack integration configuration
the team ID associated with the integration/app
the slack access token returned from the oauth
the slack incoming webhook url returned from the oauth
the default slack channel
the slack integration configuration
the team ID associated with the integration/app
the slack access token returned from the oauth
the slack incoming webhook url returned from the oauth
the default slack channel
the interval in which the monitor will be checked
the monitor description
until when the monitor will be in snoozed mode
the monitor query
Unique identifier for the entity
the inventory resource name
the inventory resource type
WEBSITE, DATABASE, COMPUTE, STRIPE, AWS_CLOUDFRONT, CLOUDFLARE, STATUS_PAGE, RDS_DATABASE timestamp when incident was closed
the user workos ID
the user email address
the user first name
the user last name
flags if the user email was already verified
the user profile picture URL
curl --request GET \
--url https://api.alerty.ai/monitor/{id}/alert \
--header 'Authorization: Bearer <token>'[
{
"id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"title": "<string>",
"description": "<string>",
"state": "TRIGGED",
"severity": "NOT_DEFINED",
"query": "<string>",
"monitor": {
"id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"pollDurationInterval": "P3Y6M4DT12H30M5S",
"name": "<string>",
"description": "<string>",
"type": "UP_TIME",
"resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"snoozedUntil": "2023-11-07T05:31:56Z",
"state": "ACTIVE",
"status": "NO_DATA",
"priority": "NOT_DEFINED",
"recipients": [
{
"id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"integration": {
"id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"type": "SLACK",
"class": "NOTIFICATION",
"configuration": {
"teamId": "<string>",
"accessToken": "<string>",
"incomingWebhookURL": "<string>",
"channelID": "<string>"
}
},
"integrationOverride": {
"teamId": "<string>",
"accessToken": "<string>",
"incomingWebhookURL": "<string>",
"channelID": "<string>"
}
}
],
"query": "<string>",
"resource": {
"id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"type": "WEBSITE",
"configuration": {
"url": "<string>"
}
}
},
"resolvedAt": "2023-11-07T05:31:56Z",
"resolvedBy": {
"id": "<string>",
"email": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"emailVerified": true,
"profilePictureURL": "<string>"
}
}
]