telemetry

Client-events summary

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.

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

Query parameters

group_bystring

source | event | tenant (tenant requires platform admin)

sourcestring

CSV of sources, e.g. plaid_link,bank_link_exchange — the bank-link chart is this filter

eventstring

exact event, e.g. HTTP_5XX

account_idstring

one account's events

group_idstring uuid

only events from members of this group; 404 group_not_found if the group is not visible to you

exclude_group_idstring uuid

drop events from members of this group; 404 group_not_found if not visible

session_idstring

one session's events — matches the server-stamped session_id OR external_session_id (e.g. a Privy sid)

sincestring

RFC3339 lower bound (clamped by the retention window)

untilstring

RFC3339 upper bound (exclusive)

intervalstring

hour | day | week | month — returns data.series bucketed at this interval

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.