Metrics API
View metrics aggregated by API Monitoring. For more information, see View metrics data using the API.
Resource Types
Error
Method | Endpoint | Description |
---|---|---|
get | /alerthistory | Gets alert history metrics for a specific organization and time interval. The maximum duration of the time interval is seven days, meaning you can view alerts only for the past seven days. By default, the API returns alerts for the previous one hour. Use the The
For example:
Notes: 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. |
get | /alertinstance/{instance_id} | Gets information about a triggered alert for an organization. Use the Get alert history API ( 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. |
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 The
For example:
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. |
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
For example:
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. |
get | /faultcodecategories | Lists available fault code categories. 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. |
get | /faultcodedetails | Lists available fault codes with details. 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. |
get | /faultcodenames | Lists fault code names. 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. |
get | /faultcodes | Lists available fault codes. 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](https://docs.apigee.com/api-monitoring/metrics |
get | /faultcodesubcategories | Lists available fault code subcategories. 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. |
get | /latency | Gets latency metrics for requests to Edge and to backend targets. Specify filters such as proxy name, interval, target, status code, and many others. For this API:
Setting interval The
The interval query parameter value supports the following format:
For example:
Setting By default, the API returns alerts for the previous hour. Use the The
For example:
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. |
get | /targets | Lists target domains for a specific organization and environment. 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. |
get | /traffic | Gets traffic metrics. Specify filters such as proxy name, interval, time window, target, status code, and many others. Setting groupBy and env The
or:
You can specify both query params. For example, the following settings aggregate metrics by environment, region, and organization and filters the results for the environment named
Setting interval The For example, if The
For example:
Setting By default, the API returns alerts for the previousz hour. Use the The
For example:
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. |
Event
Method | Endpoint | Description |
---|---|---|
get | /alerthistory | Gets alert history metrics for a specific organization and time interval. The maximum duration of the time interval is seven days, meaning you can view alerts only for the past seven days. By default, the API returns alerts for the previous one hour. Use the The
For example:
Notes: 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. |
get | /alertinstance/{instance_id} | Gets information about a triggered alert for an organization. Use the Get alert history API ( 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. |
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
For example:
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. |
Events
Method | Endpoint | Description |
---|---|---|
get | /alerthistory | Gets alert history metrics for a specific organization and time interval. The maximum duration of the time interval is seven days, meaning you can view alerts only for the past seven days. By default, the API returns alerts for the previous one hour. Use the The
For example:
Notes: 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. |
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
For example:
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. |
FaultCodeCategories
Method | Endpoint | Description |
---|---|---|
get | /faultcodecategories | Lists available fault code categories. 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. |
FaultCodeDetail
Method | Endpoint | Description |
---|---|---|
get | /faultcodedetails | Lists available fault codes with details. 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. |
FaultCodeNames
Method | Endpoint | Description |
---|---|---|
get | /faultcodenames | Lists fault code names. 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. |
FaultCodeSubCategories
Method | Endpoint | Description |
---|---|---|
get | /faultcodesubcategories | Lists available fault code subcategories. 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. |
FaultCodes
Method | Endpoint | Description |
---|---|---|
get | /faultcodes | Lists available fault codes. 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](https://docs.apigee.com/api-monitoring/metrics |
MetricsResponse
Method | Endpoint | Description |
---|---|---|
get | /latency | Gets latency metrics for requests to Edge and to backend targets. Specify filters such as proxy name, interval, target, status code, and many others. For this API:
Setting interval The
The interval query parameter value supports the following format:
For example:
Setting By default, the API returns alerts for the previous hour. Use the The
For example:
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. |
get | /traffic | Gets traffic metrics. Specify filters such as proxy name, interval, time window, target, status code, and many others. Setting groupBy and env The
or:
You can specify both query params. For example, the following settings aggregate metrics by environment, region, and organization and filters the results for the environment named
Setting interval The For example, if The
For example:
Setting By default, the API returns alerts for the previousz hour. Use the The
For example:
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. |
MetricsResult
Method | Endpoint | Description |
---|---|---|
get | /latency | Gets latency metrics for requests to Edge and to backend targets. Specify filters such as proxy name, interval, target, status code, and many others. For this API:
Setting interval The
The interval query parameter value supports the following format:
For example:
Setting By default, the API returns alerts for the previous hour. Use the The
For example:
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. |
get | /traffic | Gets traffic metrics. Specify filters such as proxy name, interval, time window, target, status code, and many others. Setting groupBy and env The
or:
You can specify both query params. For example, the following settings aggregate metrics by environment, region, and organization and filters the results for the environment named
Setting interval The For example, if The
For example:
Setting By default, the API returns alerts for the previousz hour. Use the The
For example:
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. |
MetricsSeries
Method | Endpoint | Description |
---|---|---|
get | /latency | Gets latency metrics for requests to Edge and to backend targets. Specify filters such as proxy name, interval, target, status code, and many others. For this API:
Setting interval The
The interval query parameter value supports the following format:
For example:
Setting By default, the API returns alerts for the previous hour. Use the The
For example:
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. |
get | /traffic | Gets traffic metrics. Specify filters such as proxy name, interval, time window, target, status code, and many others. Setting groupBy and env The
or:
You can specify both query params. For example, the following settings aggregate metrics by environment, region, and organization and filters the results for the environment named
Setting interval The For example, if The
For example:
Setting By default, the API returns alerts for the previousz hour. Use the The
For example:
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. |