Skip to main content
GET
Get workspace analytics

Authorizations

X-API-Key
string
header
required

Path Parameters

metric
enum<string>
required

Analytics metrics available via the public API.

Excludes billing-constraint overage keys, cross-workspace/tenant aggregates, infrastructure/worker metrics, and internal labelling-system keys.

Available options:
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,
tokens_cost_by_node,
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

Query Parameters

time_start
string<date-time>
required

Start of the time range (ISO 8601 with timezone)

time_end
string<date-time>
required

End of the time range (ISO 8601 with timezone)

page
integer | null

Page number for paginated metrics

page_size
integer | null

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

Required range: 1 <= x <= 200

Response

Successful Response

type
enum<string>
required
Available options:
simple,
barchart,
table,
horizontal-barchart,
empty
value
AnalyticsSimpleValue · object
required