Reporting & AuditingNamespace Summary

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"
}
{
  "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

MethodEndpoint
GET{baseurl}/api/vault/reports/namespace-summary

Query parameters

query
namespacestring
Required

Namespace name to report on.

query
start_datestring
Required

Start of the reporting window. Format: YYYY-MM-DD.

query
end_datestring
Required

End of the reporting window. Format: YYYY-MM-DD.

query
next_page_tokenstring

Pagination token for large result sets.

Response fields

datestring
Required

Date of the aggregated activity in each data.rows item.

api_typestring
Required

API name in each data.rows item: /mask, /unmask, etc.

statusstring
Required

success or failure in each data.rows item.

countinteger
Required

Number of API calls matching this date/type/status combination in each data.rows item.

data.next_page_tokenstring
Required

Pagination token for the next page of results.