Namespace Summary
Aggregated API usage counts for a single namespace, grouped by API type and status.
{
"namespace": "production",
"start_date": "2024-05-01",
"end_date": "2024-05-31"
}
curl -X GET "{baseurl}/api/vault/reports/namespace-summary?namespace=production&start_date=2024-05-01&end_date=2024-05-31" \
-H "Authorization: Bearer <ADMIN_USER_AUTH_KEY>"
import requests
response = requests.get(
"{baseurl}/api/vault/reports/namespace-summary",
headers={
"Authorization": "Bearer <ADMIN_USER_AUTH_KEY>"
},
params={
"namespace": "production",
"start_date": "2024-05-01",
"end_date": "2024-05-31"
}
)
print(response.json())
{
"data": {
"rows": [
{
"date": "2024-05-21",
"api_type": "/mask",
"status": "success",
"count": 14832
},
{
"date": "2024-05-21",
"api_type": "/unmask",
"status": "success",
"count": 1247
},
{
"date": "2024-05-21",
"api_type": "/unmask",
"status": "failure",
"count": 12
}
],
"next_page_token": null
},
"success": true,
"error": { "message": "" }
}
Returns aggregated API usage counts for a namespace, grouped by API type and status. Use this for high-level monitoring and usage trends.
Endpoint
| Method | Endpoint |
|---|---|
GET | {baseurl}/api/vault/reports/namespace-summary |
Query parameters
Namespace name to report on.
Start of the reporting window. Format: YYYY-MM-DD.
End of the reporting window. Format: YYYY-MM-DD.
Pagination token for large result sets.
Response fields
Date of the aggregated activity in each data.rows item.
API name in each data.rows item: /mask, /unmask, etc.
success or failure in each data.rows item.
Number of API calls matching this date/type/status combination in each data.rows item.
Pagination token for the next page of results.