Skip to main content
GET
Summarize the deployment's audit and governance records
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

Counts the deployment’s audit events by category and its governance decisions by disposition, risk class and severity for the window. summary.capped is true when a source hit its read ceiling: the counts are then a lower bound, not an exact figure. See Compliance for who can export.

Example

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

startTime
integer
required

Window start, epoch milliseconds.

endTime
integer
required

Window end, epoch milliseconds; at most 90 days after startTime.

includeClientReported
enum<string>

Exactly true includes Console-reported denials (a person saw a refusal; not gate evidence). Omitted or any other value leaves them out.

Available options:
true

Response

The summary

data
object
required

Deployment-wide counts for the window. summary.capped is true when a source hit its read ceiling: the counts are then a lower bound, not an exact figure.

meta
object
required