API metrics reporting
The application programming interface (API) metrics report provides information on client request/response activity to the requested API.
It includes a summary report and detailed reporting including API access by method.
|
If API Security Enforcer (ASE) is deployed in sideband mode, then server field in the output shows the Internet Protocol (IP) address as |
{
"company": "ping identity",
"name": "api_metrics",
"description": "This report contains metrics for request/response traffic for the specified API",
"earlier_date": "Tue Feb 13 18:00:00:000 2018",
"later_date": "Sun Feb 18 18:00:00:000 2018",
"api_name": "atm_app_public",
"req_resp_summary": {
"api_url": "/atm_app_public",
"total_requests": 2508,
"success": 2246,
"sessions": 2,
"no_sessions": 1,
"most_popular_method": "POST",
"most_popular_device": "UNKNOWN",
"most_popular_ips": [
"127.0.0.1",
"3.1.1.4"
],
"servers": [
{
"server": "127.0.0.1:3000",
"count": 2507
}
]
},
"req_resp_details": {
"api_url": "/atm_app_public",
"session_details": [
{
"session_id": "session_protocol",
"total_requests": 1,
"source_ip": [
{
"ip": "127.0.0.1",
"count": 1,
"method": [
"GET"
]
}
],
"user_agent": [
{
"user_agent": "DOWNLOAD",
"count": 1
}
],
"path_info": [
{
"path": "/atm_app_public/get400",
"count": 1
}
],
"device": [
{
"device": "UNKNOWN",
"count": 1
}
],
"server": []
},
{
"session_id": "session11",
"total_requests": 2506,
"source_ip": [
{
"ip": "127.0.0.1",
"count": 2506,
"method": [
"DELETE",
"POST",
"PUT",
"GET"
]
}
],
"user_agent": [
{
"user_agent": "DOWNLOAD",
"count": 2506
}
],
"path_info": [
{
"path": "/atm_app_public/post400",
"count": 218
},
{
"path": "/atm_app_public/put400",
"count": 18
},
{
"path": "/atm_app_public/delete200",
"count": 208
},
{
"path": "/atm_app_public/get400",
"count": 14
},
{
"path": "/atm_app_public/put200",
"count": 152
},
{
"path": "/atm_app_public/delete400",
"count": 10
},
{
"path": "/atm_app_public/get200",
"count": 104
},
{
"path": "/atm_app_public/post200",
"count": 1782
}
],
"device": [
{
"device": "UNKNOWN",
"count": 2506
}
],
"server": [
{
"server": "127.0.0.1:3000",
"count": 2506
}
]
}
],
"no_session": {
"request_details": [
{
"total_requests": 1,
"source_ip": [
{
"ip": "3.1.1.4",
"count": 1,
"method": [
"GET"
]
}
],
"user_agent": [
{
"user_agent": "DOWNLOAD",
"count": 1
}
],
"path": "/atm_app_public/get400",
"device": [
{
"device": "UNKNOWN",
"count": 1
}
],
"server": [
{
"server": "127.0.0.1:3000",
"count": 1
}
]
}
]
}
}
}json
For more information on ASE sideband mode, see the ASE Admin Guide.