You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com.

Get Events

Resource Summary

Security

Content Type

application/json, text/plain

Category

API Monitoring Metrics,

GetEvents

GET

Get Events

Get 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.

 

By default, the API returns all events for the previous hour. Use the from and to query parameters to specify a different duration. The from and to query parameter values support the following formats:

 

  • now (current local time)
  • -<value><unit> specifies 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
  • 2019-05-13T14:04:00+00:00
 

Resource URL

https://apimonitoring.enterprise.apigee.com /metrics/events

Query Parameters

Name Values Description
org
(required)

Specify the name of the Edge organization.

from

The beginning of the time interval for which alerts should be fetched. The default value is the current time minus one hour. See the description above about setting this parameter.

to

The end of the time interval for which alerts should be fetched. The default value is the current time. See the description above about setting this parameter.

alertId

Filter alert history results by the specified alert definition ID. By default, the call returns all alerts.

env

Filter events by the specified environment. By default, the call returns alerts for all environments.

name

Filter events by the specified alert name.

region

Filter events by the specified region. By default, the call returns alerts for all regions.

type

Filter events by alert type. You can use alert (all alerts other than anomaly) or anomaly. By default, all alerts are returned.

alertType

If you set type=alert lets you filter events by alert type. Currently only runtime is supported.

alertSubType

If you set type=alert and alertType=runtime lets you filter events by alert subtype. Currently only fixed is supported.

Header Parameters

Name Values Description
Authorization
(required)

OAuth token. Replace $TOKEN with your access token. See Get the tokens.

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)