GET/api/v1/automation/statistics

Get automation statistics

Returns tenant-scoped automation aggregate counts (rules and executions) plus HATEOAS links. Authentication uses x-api-key with optional x-tenant-id; RBAC requires automation:read. The service computes counts from automation_rules and automation_executions plus period-based execution totals and success rate.

RBAC · automation

Response body

Success response 200 · schema AutomationStatisticsResponse

dataobjectRequired

total_rulesintegerRequired

≥ 0

active_rulesintegerRequired

≥ 0

inactive_rulesintegerRequired

≥ 0

draft_rulesintegerRequired

≥ 0

error_rulesintegerRequired

≥ 0

total_executionsintegerRequired

≥ 0

successful_executionsintegerRequired

≥ 0

failed_executionsintegerRequired

≥ 0

executions_todayintegerRequired

≥ 0

executions_this_weekintegerRequired

≥ 0

executions_this_monthintegerRequired

≥ 0

avg_execution_time_msnumber

≥ 0

success_rate_percentnumber

≥ 0 · ≤ 100

_linksobject

selfstringRequired

Enum: /api/v1/automation/statistics

rulesstringRequired

Enum: /api/v1/automation/rules

executionsstringRequired

Enum: /api/v1/automation/executions

templatesstringRequired

Enum: /api/v1/automation/templates

performancestringRequired

Enum: /api/v1/automation/performance

Response codes

200

Automation statistics returned successfully.

401

API key is missing, invalid, expired, over limit, or the key user was not found.

403

Authenticated user lacks automation:read permission.

500

Unexpected automation statistics failure.

GET /api/v1/automation/statistics

cURL

curl -X GET "https://algapsa.com/api/v1/automation/statistics" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/automation/statistics", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/automation/statistics");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {
    "total_rules": 0,
    "active_rules": 0,
    "inactive_rules": 0,
    "draft_rules": 0,
    "error_rules": 0,
    "total_executions": 0,
    "successful_executions": 0,
    "failed_executions": 0,
    "executions_today": 0,
    "executions_this_week": 0,
    "executions_this_month": 0,
    "avg_execution_time_ms": 0,
    "success_rate_percent": 0,
    "_links": {
      "self": "/api/v1/automation/statistics",
      "rules": "/api/v1/automation/rules",
      "executions": "/api/v1/automation/executions",
      "templates": "/api/v1/automation/templates",
      "performance": "/api/v1/automation/performance"
    }
  }
}