facets

ark.get_audit_facets

Returns permissioned audit filter facets and event counts for a selected view, domain, date range, and current filters.

Parameters

viewqueryAuditView
domainViewqueryAuditDomainView
qquerystring: min length: 1; max length: 200
fromquerystring: format: date-time
toquerystring: format: date-time
subjectTypequerystring: max length: 100
subjectIdquerystring: max length: 200
actorUserIdquerystring: format: uuid
actorTypequerystring: max length: 100
eventKeyquerystring: max length: 200
eventFamilyquerystring: max length: 100
visibilityClassquerystring: one of: business, security, admin, operational
sourcequerystring: max length: 100
providerquerystring: max length: 100
correlationIdquerystring: max length: 200
transactionIdquerystring
idempotencyKeyquerystring: max length: 200
requestIdquerystring: max length: 200
teamIdquerystring: format: uuid
facetIdsqueryarray<AuditFacetId>: Comma-separated audit facet IDs to count. Omit for the default audit facets.

None.

Shell

curl 'https://arktms.com/api/v1/audit/facets' \
  -H "Authorization: Bearer $ARK_API_TOKEN"

Audit facets

objectstringrequired

okbooleanrequired

api_versionstringrequired

request_idstringrequired

dataobjectrequired

data.viewstringrequired

one of: activity, security, payments, integrations, exports, diagnostics; default: "activity"

data.domainViewstring | nullrequired

data.facetIdsarray<string> | nullrequired

data.facetsarray<object>required