---
title: Metrics REST API
description: The Metrics application programming interface (API) is used to fetch API Traffic metrics.
component: pingintelligence
version: 5.2
page_id: pingintelligence:pingintelligence_reference_guide:pingintelligence_metrics_rest_api
canonical_url: https://docs.pingidentity.com/pingintelligence/5.2/pingintelligence_reference_guide/pingintelligence_metrics_rest_api.html
revdate: April 3, 2024
---

# Metrics REST API

The Metrics application programming interface (API) *(tooltip: \<div class="paragraph">
\<p>A specification of interactions available for building software to access an application or service.\</p>
\</div>)* is used to fetch API Traffic metrics.

The response contains request count for each API, bad request count, request success, failure count, and so on.

|   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|   | If API Security Enforcer (ASE) is deployed in sideband mode, then server field in the output shows the Internet Protocol (IP) *(tooltip: \<div class="paragraph">&#xA;\<p>The method by which data is sent across the internet from the source host to the destination host.\</p>&#xA;\</div>)* address as `0.0.0.0`. For ASE deployed in inline mode, the server field shows the IP address of the backend API server. For more information on ASE sideband mode, see the ASE Admin Guide. |

`Method: GET`

`URL: /v4/abs/metrics?later_date=<>&earlier_date=<>api=<api_name>`

|            | Header     | Value       |
| ---------- | ---------- | ----------- |
| Access Key | `x-abs-ak` | *\<string>* |
| Secret Key | `x-abs-sk` | *\<string>* |

Sample Response:

```json
{
 "company": "ping identity",
 "name": "api_metrics",
 "description": " This report contains metrics for request/response traffic
  for the specified API",
 "earlier_date": "Mon Jan 13 18:00:00:000 2018",
 "later_date": "Wed Jan 15 18:00:00:000 2018",
 "api_name": "shop",
 "req_resp_summary": {
 "api_url": "shopapi",
 "total_requests": 342102,
 "success": 279360,
 "sessions": 0,
 "no_sessions": 342102,
 "most_popular_method": "GET",
 "most_popular_device": "MAC_OS_X",
 "most_popular_ips": [
 "10.10.1.38",
 "10.10.1.39",
 "10.10.1.37"
 ]
 "servers": [
 {
 "server": "192.168.11.164:3001",
 "count": 5357
 },
 {
 "server": "192.168.11.164:3002",
 "count": 5354
 },
 {
 "server": "192.168.11.164:3003",
 "count": 5358
 },
 {
 "server": "192.168.11.164:3004",
 "count": 1667
 }
 ]
 },
 "req_resp_details": {
 "api_url": "shopapi",
 "session_details": [],
 "no_session": {
 "request_details": [
 {
 "total_requests": 14865,
 "source_ip": [
 {
 "ip": "10.10.1.24",
 "count": 152,
 "method": [
 "POST"
 ]
 },
 {
 "ip": "10.10.1.71",
 "count": 482,
 "method": [
 "PUT"
 ]
 }
 ],
 "user_agent": [
 {
 "user_agent": "SAFARI",
 "count": 7187
 },
 {
 "user_agent": "FIREFOX",
 "count": 12536
 },
 {
 "user_agent": "MOZILLA",
 "count": 5509
 },
 {
 "user_agent": "CHROME",
 "count": 29241
 }
 ],
 "server": [
 {
 "server": "192.168.11.164:3001",
 "count": 723
 },
 {
 "server": "192.168.11.164:3002",
 "count": 689
 },
 {
 "server": "192.168.11.164:3003",
 "count": 749
 },
 {
 "server": "192.168.11.164:3004",
 "count": 237
 }
 ]
 "path": "/shopapi/put",
 "device": [
 {
 "device": "WINDOWS_8",
 "count": 8338
 },
 {
 "device": "MAC_OS_X",
 "count": 14276
 },
 {
 "device": "WINDOWS_XP",
 "count": 5990
 },
 {
 "device": "UBUNTU",
 "count": 6546
 }
 ]
 },
 {
 "total_requests": 2,
 "source_ip": [
 {
 "ip": "10.10.1.69",
 "count": 2,
 "method": [
 "GET"
 ]
 }
 ],
 "user_agent": [
 {
 "user_agent": "CHROME",
 "count": 2
 }
 ],
 "path": "/shopapi/get/etc",
 "device": [
 {
 "device": "MAC_OS_X",
 "count": 3
 }
 ]
 }
 ]
 }
 }
}
```