> ## 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.
# Per-bucket credits spent for the calling user within an instance scope
> Returns time-bucketed credits and message counts for the authenticated user, scoped either to `personal` usage (History rows with no institution) or to a single institution the caller belongs to. The aggregation is DocumentDB-safe (no `$facet`, no `$dateTrunc`, no `.collation()`); buckets are padded with zero-value entries so the chart renders contiguous bars. Results are cached in-memory for 60 seconds per `user × instance × window × interval × scope` (see the `X-Cache` response header). Consumed by the Usage tab in the Pricing pane. When the effective scope is `all`, buckets and totals additionally carry distinct active-user counts.
## OpenAPI
````yaml /mdx/api-reference/runtime/runtime-api.json get /api/user/usage-history
openapi: 3.0.0
info:
title: Pria Runtime 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: Audio Notes
description: Capture and ingest spoken notes into the personal vault
- name: Memory
description: User-facing memory parameters (personal + shared instance memory).
- name: My Data
description: >-
GDPR controls — personal-scope counts, async ZIP-by-email export, and
scoped soft-delete. Every endpoint pins `user = req.user._id` AND
`institution: null`; institution-scoped data is governed by the
institution's own retention policy and never reached from here.
- name: Questions
description: >-
User-facing read of the onboarding question bank used by the "create a
digital twin" wizard.
- name: Transcription
description: >-
One-shot speech-to-text for in-place dictation. Audio blob in, transcript
out — no Upload / History / RAG embeddings are persisted. Use
`/audio-notes` for anything durable.
paths:
/api/user/usage-history:
get:
tags:
- User
summary: Per-bucket credits spent for the calling user within an instance scope
description: >
Returns time-bucketed credits and message counts for the authenticated
user, scoped either to `personal` usage (History rows with no
institution) or to a single institution the caller belongs to. The
aggregation is DocumentDB-safe (no `$facet`, no `$dateTrunc`, no
`.collation()`); buckets are padded with zero-value entries so the chart
renders contiguous bars. Results are cached in-memory for 60 seconds per
`user × instance × window × interval × scope` (see the `X-Cache`
response header). Consumed by the Usage tab in the Pricing pane. When
the effective scope is `all`, buckets and totals additionally carry
distinct active-user counts.
parameters:
- in: query
name: instanceId
required: true
schema:
type: string
description: >
Either the literal string `personal` (personal-scope usage) or the
ObjectId of an institution the caller is a member of.
example: personal
- in: query
name: window
required: false
schema:
type: integer
enum:
- 7
- 14
- 30
- 90
- 180
default: 30
description: >-
Number of days of history to aggregate. Invalid values fall back to
30.
- in: query
name: interval
required: false
schema:
type: string
enum:
- daily
- weekly
- monthly
description: >
Bucket granularity. Invalid or omitted values fall back to a
window-appropriate default (daily ≤30d, weekly otherwise).
- in: query
name: scope
required: false
schema:
type: string
enum:
- own
- all
default: own
description: >
`own` (default) returns the calling user's own usage for the
instance. `all` returns aggregated usage for ALL users of the
institution — but is honored ONLY when the caller is an admin of
that institution (super, or admin with `institutions.edit`). For
non-admins, or for `personal` scope, it silently falls back to `own`
(never leaks other users' data). The EFFECTIVE scope is echoed in
the response `scope` field. The 60s TTL cache key includes the
effective scope, so own and all-users payloads never collide.
responses:
'200':
description: Bucketed usage payload
headers:
X-Cache:
schema:
type: string
enum:
- HIT
- MISS
description: Whether the payload was served from the 60s TTL cache.
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
instanceId:
type: string
example: personal
window:
type: integer
example: 30
interval:
type: string
example: daily
scope:
type: string
enum:
- own
- all
description: >-
The EFFECTIVE scope applied (falls back to `own` if the
caller isn't an institution admin).
example: own
currency:
type: string
example: usd
buckets:
type: array
description: One entry per granular bucket, ascending by start.
items:
type: object
properties:
start:
type: string
format: date-time
description: ISO timestamp of the bucket start (UTC).
example: '2026-05-01T00:00:00.000Z'
credits:
type: integer
description: Credits spent in the bucket.
example: 12
messages:
type: integer
description: Conversation messages counted in the bucket.
example: 4
users:
type: integer
description: >
Distinct users active in the bucket. Present ONLY
when the effective scope is `all` (institution
admin).
example: 7
totals:
type: object
properties:
credits:
type: integer
example: 120
messages:
type: integer
example: 48
users:
type: integer
description: >
Distinct users active across the whole window (true
distinct count, not a sum of bucket values). Present
ONLY when the effective scope is `all`.
example: 47
'400':
description: Missing or invalid instanceId
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: instanceId required
'403':
description: Caller is not a member of the requested institution
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
example: Forbidden
'500':
description: Server error
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: false
message:
type: string
security:
- apiKeyAuth: []
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````