Skip to content

User analytics query orchestrator​

GET
/auth/admin/analytics/users/query

Dispatch via view=summary|breakdown|age|metrics|cohorts|crosstab|completeness|churn|lifecycle. Requires USER_ANALYTICS MCU enabled. Aggregates only. Multi-dialect via getKyselyDb.

Authorizations​

SessionAuth

Session ID for authenticated requests

Type
API Key (header: X-Session-ID)

Parameters​

Query Parameters

from
Type
string
to
Type
string
user_type
Type
string
user_types

CSV of user_type

Type
string
include_deleted
Type
boolean
lang
Type
string
gender
Type
string
title

Courtesy title / honorific code (mr, dr, mx, …)

Type
string
is_verified
Type
boolean
compare
Type
string
Valid values
"previous"
view
Type
string

Responses​

Aggregate analytics payload (no PII)

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Multipurpose orchestrator: view=summary|breakdown|age|metrics|cohorts|crosstab|completeness|churn|lifecycle.

Path: GET /auth/admin/analytics/users/query
Auth: session with MCU-allowed role. Aggregates only (no PII).

Related: Admin API · Summary