Namespace Summary

Aggregated API usage counts for a single namespace, grouped by API type and status.

{
  "namespace": "production",
  "start_date": "2024-05-01 00:00:00",
  "end_date": "2024-05-31 23:59:59"
}

curl -X GET "https://<domain>/api/vault/reports/namespace-summary?namespace=production&start_date=2024-05-01+00:00:00&end_date=2024-05-31+23:59:59" \
  -H "Authorization: Bearer <ADMIN_USER_AUTH_KEY>"

import requests

response = requests.get(
    "https://<domain>/api/vault/reports/namespace-summary",
    headers={
        "Authorization": "Bearer <ADMIN_USER_AUTH_KEY>"
    },
    params={
        "namespace": "production",
        "start_date": "2024-05-01 00:00:00",
        "end_date": "2024-05-31 23:59:59"
    }
)
print(response.json())

{
  "data": [
    {
      "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`	`https://<domain>/api/vault/reports/namespace-summary`

Query parameters

namespacestring

Namespace name to report on.

start_datestring

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

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

next_page_tokenstring

Pagination token for large result sets.

Response fields

datestring

Required

Date of the aggregated activity.

api_typestring

Required

API name — /mask, /unmask, etc.

statusstring

Required

success or failure.

countinteger

Required

Number of API calls matching this date/type/status combination.

Was this page helpful?

{
  "namespace": "production",
  "start_date": "2024-05-01 00:00:00",
  "end_date": "2024-05-31 23:59:59"
}

curl -X GET "https://<domain>/api/vault/reports/namespace-summary?namespace=production&start_date=2024-05-01+00:00:00&end_date=2024-05-31+23:59:59" \
  -H "Authorization: Bearer <ADMIN_USER_AUTH_KEY>"

import requests

response = requests.get(
    "https://<domain>/api/vault/reports/namespace-summary",
    headers={
        "Authorization": "Bearer <ADMIN_USER_AUTH_KEY>"
    },
    params={
        "namespace": "production",
        "start_date": "2024-05-01 00:00:00",
        "end_date": "2024-05-31 23:59:59"
    }
)
print(response.json())

{
  "data": [
    {
      "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": "" }
}