Pular para o conteúdo

Get Automation Dashboard

GET
/api/v1/automations/dashboard

Get comprehensive dashboard analytics for automation system.

Includes:

  • Summary statistics (today, week, month)
  • Execution breakdown by status and trigger type
  • Time series data for charts (last 30 days)
  • Top performing and failing workflows
  • Recent execution activity
  • Resource usage (AI tokens, API calls, messages)
x-tenant-id
Any of:
integer

Successful Response

DashboardResponse

Full dashboard analytics response

object
total_workflows
required
Total Workflows
integer
active_workflows
required
Active Workflows
integer
total_executions_today
required
Total Executions Today
integer
total_executions_week
required
Total Executions Week
integer
total_executions_month
required
Total Executions Month
integer
success_rate_today
required
Success Rate Today
number
success_rate_week
required
Success Rate Week
number
success_rate_month
required
Success Rate Month
number
executions_by_status
required
ExecutionsByStatus

Execution counts by status for charts

object
completed
Completed
integer
0
failed
Failed
integer
0
running
Running
integer
0
pending
Pending
integer
0
cancelled
Cancelled
integer
0
executions_by_trigger
required
TriggerTypeStats

Execution counts by trigger type

object
event
Event
integer
0
schedule
Schedule
integer
0
schedule_filtered
Schedule Filtered
integer
0
webhook
Webhook
integer
0
manual
Manual
integer
0
executions_per_day
required
Executions Per Day
Array<object>
TimeSeriesDataPoint

Single data point in time series

object
date
required
Date
string
count
required
Count
integer
successful
Successful
integer
0
failed
Failed
integer
0
top_workflows
required
Top Workflows
Array<object>
WorkflowPerformance

Performance metrics for a single workflow

object
workflow_id
required
Workflow Id
integer
workflow_name
required
Workflow Name
string
status
required
Status
string
total_executions
required
Total Executions
integer
successful_executions
required
Successful Executions
integer
failed_executions
required
Failed Executions
integer
success_rate
required
Success Rate
number
avg_duration_ms
Any of:
number
last_execution_at
Any of:
string format: date-time
failing_workflows
required
Failing Workflows
Array<object>
WorkflowPerformance

Performance metrics for a single workflow

object
workflow_id
required
Workflow Id
integer
workflow_name
required
Workflow Name
string
status
required
Status
string
total_executions
required
Total Executions
integer
successful_executions
required
Successful Executions
integer
failed_executions
required
Failed Executions
integer
success_rate
required
Success Rate
number
avg_duration_ms
Any of:
number
last_execution_at
Any of:
string format: date-time
recent_executions
required
Recent Executions
Array<object>
RecentExecution

Simplified execution for recent activity list

object
id
required
Id
integer
workflow_id
required
Workflow Id
integer
workflow_name
required
Workflow Name
string
status
required
Status
string
trigger_type
required
Trigger Type
string
started_at
Any of:
string format: date-time
completed_at
Any of:
string format: date-time
duration_ms
Any of:
integer
error_message
Any of:
string
total_ai_tokens_today
Total Ai Tokens Today
integer
0
total_api_calls_today
Total Api Calls Today
integer
0
total_messages_sent_today
Total Messages Sent Today
integer
0

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string