All Namespace Summary

Overview #

This method provides a response for a specific user, detailing the number of calls (e.g., mask, unmask, async) they made within a specified duration

This API endpoint is used to retrieve a summary of all namespaces with their respective count

HTTP Method #

GET

Endpoint #

/reports/all-namespace-summary

Headers #

• Authorization: "Bearer <ADMIN_USER_AUTH_KEY>"

Query Parameters #

• 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

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

Response Format #

{
    "data": {
        "details": [
            {
                "namespace": "protecto_vault_charlotte",
                "start_time": "2024-05-28 17:33:58.346323",
                "end_time": "2024-05-28 18:23:42.168187",
                "count": 27
            },
            {
                "namespace": "protecto_vault_olivia",
                "start_time": "2024-05-28 17:26:37.801605",
                "end_time": "2024-05-28 17:31:49.704534",
                "count": 6
            }
        ],
        "next_page_token": "eyJwYWdlX3NpemUiOiA1LCAicGFnZV9ubyI6IDEsICJ0b3RhbF9wYWdlcyI6IDJ9"
    },
    "success": true,
    "error": {
        "message": ""
    }
}

Response Fields #

• data: An object containing the namespace details and pagination information.
  • details: A list of namespace summary objects.
    • namespace: The name of the namespace.
    • start_time: The start time of the namespace summary period.
    • end_time: The end time of the namespace summary period.
    • count: The count of items in the namespace.
  • next_page_token: A token used for paginating to the next page of data.
• success: A boolean indicating if the request was successful.
• error: An object containing error details, if any.
  • message: A message describing the error.

Notes #

• Ensure that the Authorization header contains a valid admin user auth key.
• The start_date and end_date query parameters must be in the correct format to avoid errors.
• Use the next_page_token from the response for paginating through large datasets. If there is no next_page_token in the response, it indicates that there are no additional pages.