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. For cross-site search, click Search all in the search results.

Get Alert Count

Resource Summary

Security

Content Type

application/json, text/plain

Category

API Monitoring Metrics,

GetAlertCount

GET

Get Alert Count

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

 

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

 

For more information and examples of this API, see View metrics data using the API.

Resource URL

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

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 in the ISO date format. The default value is the current time. See the description above about setting this parameter.

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?)