telemetry

Feed

Client telemetry for the caller's own tenant by default — a platform admin included; a platform admin passes tenant_id for another tenant or all_tenants=true for every tenant. A non-admin passing a FOREIGN tenant_id or all_tenants gets 403 rather than being silently shown their own tenant's feed. source is a CSV of event sources (e.g. plaid_link,bank_link_exchange,plaid_refresh_patch,external_bank_unlink,bank_link_funnel); session_id matches either the server-stamped session_id or an external_session_id (e.g. a Privy sid). account_id narrows to one account; group_id / exclude_group_id to (non-)members of a group, by the event's account. from/to bound created_at (half-open, ADR 0003 dates) inside the 30-day retention window. Newest first by default; sort=oldest reverses; ties break on id.

get/admin/client-events

Request

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

Query parameters

sourcestring

CSV of telemetry sources to filter (e.g. plaid_link,bank_link_exchange)

eventstring

single event filter, e.g. EXIT

account_idstring uuid

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

fromstring

created_at >= this (YYYY-MM-DD = start of that UTC day, or RFC3339); since is an alias

tostring

created_at < this (YYYY-MM-DD = that whole UTC day inclusive, or RFC3339 exclusive); until is an alias

sort'recent' | 'oldest'

recent = newest first (default), oldest = oldest first; ties break on id

limitinteger

page size

offsetinteger

page offset

session_idstring

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

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

limitinteger
offsetinteger
totalinteger

Changes

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