get /alertsummary

Gets the total count of alerts for an organization and time interval.

By default, the API returns alerts 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 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

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

Query Parameters

org (required)

string

Organization name.

from

string
Default value
"-1h"

Start of the time interval for which alerts should be fetched. Defaults to the current time minus one hour. Required for latency metrics.

to

string
Default value
"now"

End of the time interval for which alerts should be fetched. Defaults to the current time.

Response Types

default: 

Unexpected error

Body

application/json
Error
error

string

Error message

200: 

Query results

Body

application/json
array
object
event

object

environment

string

Environment name.

count

integer

Number of for the environment.

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)

Key location: header
Parameter name: Authorization

Try this API

Request parameters
org
from
to
Credentials
OAuth
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)