get /events
Gets all events in an organization for a specified time interval. The list of events includes anomalies detected by Edge and any triggered alerts. The alerts can include both fixed and anomaly alerts.
The from
and to
query parameter values support the following formats:
now
(current time)-<value><unit>
specifes a time in the past (note the leading hyphen):<value>
– an integer<unit>
– a time unit of:s
,sec
,second
,m
,min
,minute
,h
,hr
,hour
,d
,day
- An ISO formatted date as either:
yyyy-mm-ddThh:mm:ssZ
yyyy-mm-ddThh:mm:ss+00:00
For example:
now
-1h
-10min
2018-08-13T14:04:00+00:00
Note: You can call this API at most six times per minute. For more information and examples of this API, see View metrics data using the API.
HTTP request
Query Parameters
org (required) | Organization name. |
from |
Start of the time interval for which alerts should be fetched. Defaults to the current time minus one hour. Required for latency metrics. |
to |
End of the time interval for which alerts should be fetched. Defaults to the current time. |
alertId | Filter alert history by the specified alert definition ID. To get a list of alert IDs, see Get alerts. |
env | Filter events by the specified environment. |
name | Filter events by the specified name. The semantics of name depends on the type of the event. |
region | Filter events by the specified region. |
type | Filter events by the specified type. Valid values include |
alertType | Filter alert events by the specified alertType. The only valid value is |
alertSubType | Filter alert events by the specified alertSubType. Valid values include |
Response Types
default:
Unexpected error
200:
Query results
Body
id | Alert ID. |
shared_id | TBD |
entity_key | Entity key. |
entity_value | Entity value. |
dependent_entity_key | Dependent entity key. |
dependent_entity_value | Dependent entity value. |
component | Component. |
pod | Pod. |
region | Region. |
organization | Organization name. |
environment | Environment name. |
name | Name of the alert. |
type | Type of event. Valid values include |
source | Source of the alert. |
raw_payload | Raw payload of the alert. For details, see Alert. |
time | Time the alert was triggered. |
Authentication Requirements
For OAuth, enter the following in the Key field: Bearer %your-token% (see https://docs.apigee.com/api-platform/system-administration/using-oauth2#get-the-tokens)