> ## Documentation Index
> Fetch the complete documentation index at: https://docs.praxis-ai.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Live 24h cap-effectiveness analytics
> For every institution in the caller's scope that has an ACTIVE per-user 24-hour credit cap, reports how many members are at/over their cap right now (reached) versus under it. Scope is resolved exactly like the user list (institution → account → the institutions the caller administers). Usage is the pooled 24h credit sum per member; members with no recorded pooled usage count as under the cap.
## OpenAPI
````yaml /mdx/api-reference/admin/admin-api.json post /api/admin/users/cap-effectiveness
openapi: 3.0.0
info:
title: Pria Admin API
version: 2.0.1
description: >-
Pria API Documentation Praxis's developer platform is a core part of our
mission to empower organizations to grow better. Our APIs are designed to
enable teams of any shape or size to build robust integrations that help
them customize and get the most value out of Pria. All Pria APIs are built
using REST conventions and designed to have a predictable URL structure.
They use many standard HTTP features, including methods (POST,
GET, PUT, DELETE) and error response codes.
All API calls are
made under https://hiimpria.ai/api and all responses return standard JSON.
In these docs, you'll find lists of all available endpoints for a given API,
along with interactive code blocks for building requests. For walkthroughs
of basic usage for these APIs, check out the API guides.
servers:
- url: https://pria.praxislxp.com
description: Pria API Server
security: []
tags:
- name: Authentication
description: User authentication, registration, and password management (/api/auth)
- name: OAuth
description: OAuth authentication providers - Google, GitHub, SSO (/api/auth/oauth)
- name: User
description: User profile management and account operations (/api/user)
- name: User Institutions
description: User institution memberships and switching (/api/user/institution)
- name: User Tools
description: Available tools for authenticated users (/api/user/tools)
- name: Institutions
description: Institution settings and configuration (/api/user/institution)
- name: Conversation
description: AI conversation and Q&A endpoints (/api/ai)
- name: Realtime
description: Real-time voice AI and WebRTC sessions (/api/ai/rt)
- name: Assistant
description: AI assistant configuration and management (/api/user/assistant)
- name: History
description: Conversation history and favorites (/api/user/history)
- name: RAG
description: >-
Document upload, embedding, and retrieval-augmented generation
(/api/user/files, /api/user/rag)
- name: Setting
description: Instance variables and settings management (/api/user/setting)
- name: Branding
description: Digital twin branding and customization (/api/agent/branding)
- name: Agent
description: Agent engagement and session management (/api/agent)
- name: SDK Launch
description: >-
SDK launch token signing and verification for secure iframe embedding
(/api/auth/sdk-sign, /api/auth/sdk-verify)
- name: Testing
description: Health checks, diagnostics, and test endpoints (/api/test)
- name: Admin Accounts
description: Account management for super admins (/api/admin/account)
- name: Admin Institutions
description: Institution management for admins (/api/admin/institution)
- name: Admin Users
description: User management for admins (/api/admin/user)
- name: Admin Entitlements
description: >-
User-institution relationships and permissions
(/api/admin/userInstitution)
- name: Admin Sessions
description: Session management for admins (/api/admin/session)
- name: Admin Histories
description: Conversation history management and analytics (/api/admin/history)
- name: Admin Assistants
description: AI assistant management for admins (/api/admin/assistant)
- name: Admin Questions
description: Institution question and prompt management (/api/admin/question)
- name: Admin Tools
description: Tool configuration management (/api/admin/tool)
- name: Admin AI Models
description: AI model configuration (/api/admin/aimodel)
- name: Admin MCP Servers
description: Model Context Protocol server management (/api/admin/mcpserver)
- name: Admin Feedbacks
description: User feedback management (/api/admin/feedback)
- name: Admin Uploads
description: Upload management (/api/admin/upload)
- name: Admin Charts
description: Analytics and visualization chart management (/api/admin/chart)
- name: Admin Memory
description: Admin inspection and editing of user/instance memory parameters.
- name: Admin Usage Limits
description: Per-user usage-vs-cap reporting and account-wide at-limit counts.
paths:
/api/admin/users/cap-effectiveness:
post:
tags:
- Admin Users
summary: Live 24h cap-effectiveness analytics
description: >-
For every institution in the caller's scope that has an ACTIVE per-user
24-hour credit cap, reports how many members are at/over their cap right
now (reached) versus under it. Scope is resolved exactly like the user
list (institution → account → the institutions the caller administers).
Usage is the pooled 24h credit sum per member; members with no recorded
pooled usage count as under the cap.
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
account:
type: string
description: Space-separated account id(s) to scope to.
institution:
type: string
description: >-
Space-separated institution id(s) to scope to (takes
precedence over account).
usersearch:
type: string
description: >-
Case-insensitive substring matched against member email /
first / last name to narrow the membership tally.
accountType:
type: string
description: >-
Restrict the membership tally to members with this account
type.
responses:
'200':
description: Cap-effectiveness report.
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
type: array
items:
type: object
properties:
institutionId:
type: string
institutionName:
type: string
account:
type: string
nullable: true
cap:
type: number
description: The active per-user 24h cap for this institution.
members:
type: integer
reached:
type: integer
description: >-
Members whose pooled 24h usage is at or over the
cap.
under:
type: integer
reachedPct:
type: integer
description: Percentage of members at/over the cap (0-100).
totals:
type: object
properties:
institutions:
type: integer
members:
type: integer
reached:
type: integer
reachedPct:
type: integer
generatedAt:
type: string
format: date-time
'401':
description: Unauthorized - Invalid or missing access token
'403':
description: Forbidden - Insufficient permissions
'408':
description: Aggregation timed out - narrow the filter and retry.
'500':
description: Internal server error
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````