All namespace usage summary

Note: APIsmeter Billing are not available for trial users. A subscription is required to access these features. Please get in touch with help@protecto.ai for assistance. #

This API provides a usage summary either across all namespaces if the authorization header contains the master API key, or for a specific namespace if the namespace name is provided in the query parameters or if the authorization header contains the user namespace admin key.

The usage summary includes the following metrics:

1. Namespace name
2. The date range of usage
3. Total API hits
4. Number of mask hits
5. Number of unmasked hits
6. Number of asynchronous mask hits
7. Number of asynchronous unmask hits
8. Number of status tracking hits

METHOD: GET
ROUTE: /reports/usage-summary
Headers:
{
“Authorization”: “Bearer <MASTER_API_KEY (OR) NAMESPACE_ADMIN_API_KEY >”
}
Query params:

namespace: Optional param eg: “protecto_vault_charlotte”
start_date: This date is inclusive.Format should be “YYYY-MM-DD HH:MM:SS” eg: “2024-05-21  18:23:42”
end_date: This date is inclusive. Format should be “YYYY-MM-DD HH:MM:SS” eg: “2024-05-22  28:23:32”
next_page_token: It is used to paginate the data; by default, it will be null.
If there is more data, then next_page_token will be sent through the API response. For upcoming requests, use the previous response next_page_token to navigate further.

Response structure:

{
"data": {
"details": [
{
"namespace": "protecto_vault_charlotte",
"start_time": "2024-05-28 17:33:58.346323",
"end_time": "2024-05-28 18:23:42.168187",
"no_of_hits": {
"mask": 5,
"unmask": 5,
"mask/async": 10,
"unmask/async": 10,
"status-tracking": 40,
"total": 70
}
},
{
"namespace": "protecto_vault_olivia",
"start_time": "2024-05-28 17:26:37.801605",
"end_time": "2024-05-28 17:31:49.704534",
"no_of_hits": {
"mask": 2,
"unmask": 7,
"mask/async": 70,
"unmask/async": 110,
"status-tracking": 140,
"total": 329
}
}
],
"next_page_token": "eyJwYWdlX3NpemUiOiA1LCAicGFnZV9ubyI6IDEsICJ0b3RhbF9wYWdlcyI6IDJ9"
},
"success": "true",
"error": {
"message": ""
}
}