Skip to main content
GET
Get Dashboard Stats
Returns high-level statistics and metrics for dashboard reporting and automation.

Authentication

This endpoint requires a valid JWT token from Clerk authentication. The token must include organization membership.

Query Parameters

string
required
Start date for the query range (ISO 8601 format, e.g., “2024-01-01T00:00:00.000Z”)
string
required
End date for the query range (ISO 8601 format, e.g., “2024-12-31T23:59:59.999Z”)
boolean
default:"false"
Whether to include stats for all users in the organization. Requires org:admin role.
string
Filter results to a specific agent ID
string
Filter results to a specific user ID (admin only when allInOrg is true)
string
Filter by a specific metadata key in user’s organization-scoped metadata
string
Filter by a specific metadata value. Can be used with or without metadataKey. Only searches within the current organization.

Response

number
Total number of unique conversations
number
Total number of messages across all conversations
number
Total number of tool invocations across all messages
number
Total token usage across all conversations
number
Total input tokens (user messages and system prompts) across all conversations
number
Total output tokens (assistant responses) across all conversations
number
Number of unique users who participated in conversations
number
Number of unique agents used in conversations
number
Total number of feedback responses (helpful + not helpful)
number
Number of positive feedback responses
number
Number of negative feedback responses
number
Total number of knowledge base files processed in the date range (organization-wide, not filtered by user or agent)
number
Number of distinct knowledge bases with files processed in the date range
number
Total tokens consumed by LLM-based document extraction across all knowledge base files in the date range
number
Input tokens consumed by LLM-based document extraction (document content sent to the model)
number
Output tokens consumed by LLM-based document extraction (structured data generated by the model)

Examples

Error Codes

object
Forbidden - User lacks required permissions (e.g., non-admin trying to use allInOrg=true)
object
Internal Server Error - Server encountered an unexpected condition

Notes

  • All dates should be provided in ISO 8601 format
  • When allInOrg=true, only users with org:admin role can access organization-wide data
  • Metadata filtering is organization-scoped: Only searches within the current organization’s user metadata
  • Metadata filtering supports flexible querying across user’s publicMetadata JSON field
  • Token counts include both input and output tokens from conversations
  • Tool calls are counted across all message toolInvocations arrays
  • Knowledge base stats (kbFileCount, kbCount, kbExtractTotalTokens, kbExtractInputTokens, kbExtractOutputTokens) are always organization-wide and are not filtered by userId, agentId, or metadata parameters