> ## 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.
# Get time-series chart data for histories
> Optimized endpoint for time-series charts (bar, line, area, heatmap, scatter). Supports count, credits, usage, cached, and price dimensions. Uses a 2-step top-N query to avoid fetching data for all institutions.
## OpenAPI
````yaml /mdx/api-reference/admin/admin-api.json post /api/admin/histories/charts/timeline
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/histories/charts/timeline:
post:
tags:
- Admin Histories
summary: Get time-series chart data for histories
description: >
Optimized endpoint for time-series charts (bar, line, area, heatmap,
scatter). Supports count, credits, usage, cached, and price dimensions.
Uses a 2-step top-N query to avoid fetching data for all institutions.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TimelineChartRequest'
responses:
'200':
description: Successfully retrieved timeline chart data
content:
application/json:
schema:
$ref: '#/components/schemas/ChartResponse'
'400':
description: Invalid parameters
'401':
description: Unauthorized
security:
- apiKeyAuth: []
components:
schemas:
TimelineChartRequest:
type: object
required:
- granularity
- range
- dimension
properties:
institution:
type: string
description: Institution ID (optional, filters by institution)
example: 65cfebc32f5e1b37d4e52329
account:
type: string
description: Account ID (optional, filters by account's institutions)
granularity:
type: string
enum:
- day
- week
- month
- hour
description: Time granularity for bucketing
example: month
range:
type: integer
description: Time range (negative values for past periods)
example: -3
dimension:
type: string
enum:
- count
- credits
- usage
- cached
- price
description: Metric to aggregate
example: count
aggregate:
type: boolean
description: When true, aggregates across all institutions
example: false
topsearch:
type: integer
description: Number of top institutions to return (default 5, -1 for all)
example: 5
ChartResponse:
type: object
properties:
success:
type: boolean
description: Indicates if the request was successful
data:
type: array
items:
$ref: '#/components/schemas/ChartDataPoint'
description: Array of chart data points
ChartDataPoint:
type: object
properties:
_id:
type: object
properties:
granularity:
type: string
format: date-time
description: The time period for the data point
institution:
type: string
description: The institution ID
dimension:
type: number
description: The count value for this time period
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: x-access-token
description: JWT token passed in x-access-token header
````