logo
Reporting & AuditingUser-Level Namespace Summary

User Namespace Summary

API usage per user within a namespace — call counts, success rates, and login times over a date range.

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

{
  "data": [
    {
      "date": "2024-05-21",
      "api_type": "/mask",
      "status": "success",
      "user": "alice@company.com",
      "logged_in_time": 3600
    },
    {
      "date": "2024-05-21",
      "api_type": "/unmask",
      "status": "success",
      "user": "bob@company.com",
      "logged_in_time": 1800
    }
  ],
  "next_page_token": null,
  "success": true,
  "error": { "message": "" }
}

Returns API usage per user within a namespace over a given time range. Use this to understand which users are actively calling APIs, how long they were active, and whether their calls succeeded.

Endpoint

MethodEndpoint
GEThttps://<domain>/api/vault/reports/namespace-users-summary

Query parameters

query
namespacestring
Required

Namespace name to report on.

query
start_datestring
Required

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

query
end_datestring
Required

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

query
next_page_tokenstring

Pagination token for large result sets.

Response fields

datestring
Required

Date of the activity.

api_typestring
Required

API called — /mask, /unmask, /async-status, etc.

statusstring
Required

success or failure.

userstring
Required

User email associated with the calls.

logged_in_timeinteger

Time active in the namespace, in seconds.

Was this page helpful?

Last updated 3 weeks ago

Built with Documentation.AI