V1 - Analytics

Get workspace analytics

Query analytics metrics for the workspace associated with the API key. Results are scoped to the workspace and time range provided.

get/v1/analytics/{metric}

Request

  • Base URL
    https://api.app.noxus.ai (the document declares no server; this is the origin it was published from)
  • Auth
    API key in header X-API-Key

Path parameters

metric'flow_runs' | 'trigger_runs' | 'manual_runs' | 'agent_runs' | 'active_users' | 'active_runs' | 'active_triggers' | 'errors' | 'average_run_time' | 'flow_runs_distribution' | 'flow_per_user' | 'errors_over_time' | 'run_time_over_time' | 'ai_models_total_cost' | 'ai_models_total_tokens' | 'average_cost_per_run' | 'tokens_cost' | 'tokens_cost_by_workflow' | 'tokens_cost_by_user' | 'model_tokens_total_cost' | 'ai_operations_per_tool' | 'model_tokens_per_tool' | 'ai_operations_per_user' | 'model_tokens_per_user' | 'conversations_started' | 'messages_sent' | 'messages_per_conversation' | 'conversation_users' | 'conversations_started_over_time' | 'messages_sent_over_time' | 'conversations_started_by_user' | 'messages_sent_by_user' | 'conversation_tokens_cost' | 'conversation_tokens_cost_by_user' | 'conversation_chat_costs_total' | 'api_calls_per_date' | 'api_calls_per_endpoint' | 'api_calls_log' | 'kb_total_documents' | 'kb_processed_successfully' | 'kb_contributors' | 'kb_failed_documents' | 'kb_documents_over_time' | 'kb_documents_per_kb' | 'kb_documents_by_user' | 'kb_document_types' | 'kb_user_activity' | 'kb_overview' required

Analytics metrics available via the public API.

Excludes billing-constraint overage keys, cross-workspace/tenant aggregates, infrastructure/worker metrics, internal labelling-system keys, and workflow-scoped keys that need a flow id this surface does not take.

Query parameters

time_startstring date-time required

Start of the time range (ISO 8601 with timezone)

time_endstring date-time required

End of the time range (ISO 8601 with timezone)

pageinteger nullable

Page number for paginated metrics

page_sizeinteger nullable

Page size for paginated metrics (default 50, max 200)

Response

Successful Response

type'simple' | 'barchart' | 'table' | 'horizontal-barchart' | 'empty' required

Changes

No recorded changes to this operation across all 1 revision of this API.