---
title: "Client-events summary"
method: GET
path: "/admin/client-events/summary"
tags: ["telemetry"]
---

# Client-events summary

`GET /admin/client-events/summary`

## Request

- Base URL: `https://api.instruxi.dev/api/v1/enforcer`
- URL: `https://api.instruxi.dev/api/v1/enforcer/admin/client-events/summary`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `X-API-Key`

Aggregated client telemetry: totals, per-dimension buckets (group_by=source|event|tenant — tenant requires the platform-admin grant, since it degenerates to one bar for anyone else), and an optional time series bucketed at interval (hour|day|week|month) in the tz IANA zone (default UTC). Uses the SAME row scope and filter vocabulary as adminListClientEvents, so every tile has a drill-down list covering exactly the rows it counted.

## Query parameters

- `group_by` string
- `source` string
- `event` string
- `account_id` string
- `group_id` string, uuid
- `exclude_group_id` string, uuid
- `session_id` string
- `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
- `404`: group_not_found

---

[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)