---
title: "Summary"
method: GET
path: "/groups/summary"
tags: ["groups"]
---

# Summary

`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`

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.

## Query parameters

- `metric` string
- `group_by` 'visibility' | 'size_band'
- `group_id` string, uuid
- `q` string
- `include_reserved` boolean
- `archived` 'false' | 'true' | 'all'
- `since` string
- `until` string
- `interval` string
- `tz` string
- `tenant_id` string, uuid
- `all_tenants` boolean

## Response `200`

OK

- EnforcerV3InternalDomainSummaryResponse
  - `data` EnforcerV3InternalDomainSummaryData
    - `buckets` EnforcerV3InternalDomainSummaryBucket[]
      - `count` integer
      - `key` string
      - `label` string
      - `pct` number
    - `dimension` string
    - `multi_valued` boolean
    - `series` EnforcerV3InternalDomainSummaryPoint[]
      - `by` object
      - `count` integer
      - `ts` string
    - `total` integer
    - `truncated` boolean
  - `success` boolean
  - `window` EnforcerV3InternalDomainSummaryWindow
    - `interval` string
    - `since` string
    - `tz` string
    - `until` string

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: forbidden: tenant_id/all_tenants beyond your own tenant without the cross_tenant grant

---

[API](https://skmtc.dev/instruxi/apis/enforcer-api.md) · [All operations](https://skmtc.dev/instruxi/apis/enforcer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/instruxi/apis/enforcer-api/revisions/fa82bc1becc0?raw)