Alert Object

Defines the schema for an alert within incidents in BigPanda


Expanding Alert Data

To include the full alert object for each retrieved incident, include expand=alerts in the query.

When making a call with alerts expanded, page size cannot be larger than 10. An expanded call with a page size greater than 10 will return a 400 error.


The Alert object schema includes the following attributes:

idSystem-generated unique identifier for the alertString
statusThe most severe status the alert triggered

Possible returns are: critical, warning, unknown, ok
startUnix epoch time when the alert was received (in seconds).Timestamp (in seconds)
endUnix epoch time when the alert was resolved (in seconds).Timestamp (in seconds)
changed_atUnix epoch time when the alert status last changed (in seconds).Timestamp (in seconds)
updated_atUnix epoch time when the last change to the alert occurred (in seconds).Timestamp (in seconds)
last_event_atUnix epoch time when the last alert event occurred (in seconds).Timestamp (in seconds)
activeWhether the alert is active and has not been manually resolved.Boolean
primary_propertyMain object that triggered the alertString
secondary_propertySecondary object or sub-item that triggered the alertString
source_systemIntegrated monitoring system that sent the alert to BigPandaString
incident_keyA unique id BigPanda uses to recognize if two events are related to each otherString
maintenance_plansIf alert is in maintenance, returns the plan idsArray
descriptionBrief summary (max. 2048 characters) of the alert included by certain monitoring toolsString
tagsArray of name-value pairs that represent alert properties.

name - Tag name in BigPanda.
value - Tag value in BigPanda.

Note: Tag values are limited to 15 items and/or 512 characters total.
  "alert_id": "60a4ee83bb7d9d046b8d7a93",
  "status" : "critical",
  "start": 1466416853,
  "end": null,
  "changed_at": 1466417169,
  "updated_at": 1466417169,
  "last_event_at": 1466417169,
  "active": true,
  “primary_property”: “host”,
  “secondary_property”: “check”,
  "source_system": "api.backend_monitoring",
  "incident_key" : “prod-mwv2-demo-1__Host is down”,
  “maintenance_plans”: “60450a8012d7dd0464f1b87dl”,
  "description": "CRITICAL - Host Unreachable",
  "tags":[ {"name":"host","value":"production-database-1"}, {"name":"check","value":"CPU load"} ]