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.

{
  "namespace": "production",
  "start_date": "2024-05-21",
  "end_date": "2024-05-22"
}
{
  "data": {
    "rows": [
      {
        "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
GET{baseurl}/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

query
end_datestring
Required

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

query
next_page_tokenstring

Pagination token for large result sets.

Response fields

The following fields are returned for each row in data.rows.

data.rows.datestring
Required

Date of the activity.

data.rows.api_typestring
Required

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

data.rows.statusstring
Required

success or failure.

data.rows.userstring
Required

User email associated with the calls.

data.rows.logged_in_timeinteger

Time active in the namespace, in seconds.

data.next_page_tokenstring

Pagination token for the next page of rows.

Was this page helpful?