Individual Namespace Summary

Overview #

This method provide the name of API calls (mask, unmask, async) made by a specific user within the specified time period with status(Success or Failure) and with count.

This API endpoint retrieves the summary of an individual namespace, grouped by API type and count.

HTTP Method #

GET

Endpoint #

/reports/namespace-summary

Headers #

• Authorization: "Bearer <ADMIN_USER_AUTH_KEY>"

Query Parameters #

• namespace (required): The namespace, which is the user database name.
• start_date (required): The start date and time for the report. Format should be "YYYY-MM-DD HH:MM:SS". For example: "2024-05-21 00:00:00".
• end_date (required): The end date and time for the report. Format should be "YYYY-MM-DD HH:MM:SS". For example: "2024-05-22 23:59:59".
• next_page_token (optional): Used to paginate the data. By default, it will be empty. If there is more data, next_page_token will be sent through the API response. For subsequent requests, use the previous response’s next_page_token to navigate further.

Code Snippet

Request

GET https://<domain>/api/vault/reports/namespace-summary?namespace=protecto_vault&start_date=2024-05-21 00:00:00&end_date=2024-05-22 23:59:59&next_page_token=

Response Format #

{
    "data": {
        "details": [
            {
                "date": "2024-05-28",
                "api_type": "/async-status",
                "status": "success",
                "count": 3
            }
        ],
        "next_page_token": "eyJwYWdlX3NpemUiOiA1LCAicGFnZV9ubyI6IDEsICJ0b3RhbF9wYWdlcyI6IDJ9"
    },
    "success": true,
    "error": {
        "message": ""
    }
}