groups

Summary

Two modes: the default returns group-entity counts (created-when, size) bucketed by group_by=visibility|size_band; metric=joins instead returns membership JOIN events over time (group_id narrows to one group's joins). metric=joins counts joins ONLY, never net membership — account_groups rows are hard-deleted on removal, so a leave leaves nothing to count and the series can only ever climb. Net membership requires the group.member_added/group.member_removed audit events instead, and only from when those began recording. An unrecognized metric value is a 400 unsupported_metric rather than silently falling back to group counts.

get/groups/summary

Request

  • Base URL: https://api.instruxi.dev/api/v1/enforcer
  • URL: https://api.instruxi.dev/api/v1/enforcer/groups/summary
  • Auth: one of:
    • API key in header Authorization
    • API key in header X-API-Key

Query parameters

metricstring

joins — membership join events instead of groups

group_by'visibility' | 'size_band'

bucket dimension (ignored when metric=joins)

group_idstring uuid

with metric=joins: only joins into this group

qstring

search name or description

include_reservedboolean

also count groups of RESERVED types (hidden by default, as on GET /groups)

archived'false' | 'true' | 'all'

archive state, as on GET /groups: false (default) | true | all

sincestring

RFC3339 lower bound (inclusive)

untilstring

RFC3339 upper bound (exclusive)

intervalstring

hour | day | week | month — returns data.series

tzstring

IANA time zone for bucketing (default UTC)

tenant_idstring uuid

list this tenant instead of your own (default: the caller's own tenant, platform admins included). Another tenant requires the cross_tenant grant — 403 otherwise

all_tenantsboolean

list EVERY tenant (platform-wide admin view). Requires the cross_tenant grant — 403 otherwise. Mutually exclusive with tenant_id (400 conflicting_tenant_scope)

Response

OK

successboolean

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.