GET/api/v1/automation/performance

Get automation performance metrics

Returns performance metrics calculated by AutomationService.calculatePerformanceMetrics for the authenticated tenant. Authentication uses x-api-key with optional x-tenant-id; RBAC requires automation:read. Query is validated with performanceMetricsRequestSchema; because validateQueryParams maps URL values to strings, array filters (rule_ids, metrics) currently have parsing limitations and may fail validation unless encoded specially.

RBAC · automation

Query parameters

date_fromstring <date-time>Optional

Optional lower bound for performance window.

date_tostring <date-time>Optional

Optional upper bound for performance window.

group_bystringOptional

Aggregation bucket size; defaults to day.

rule_idsstringOptional

Raw query value copied from URL. The controller expects an array UUID schema but validateQueryParams passes string values, so array filters currently require custom caller-side encoding or fail validation.

metricsstringOptional

Raw query value copied from URL. The controller expects an array enum schema but validateQueryParams passes string values, so array filters currently require custom caller-side encoding or fail validation.

Response body

Success response 200 · schema AutomationPerformanceResponse

dataobjectRequired

Performance payload from AutomationService.calculatePerformanceMetrics plus links.

_linksobject

selfstringRequired

Enum: /api/v1/automation/performance

statisticsstringRequired

Enum: /api/v1/automation/statistics

Response codes

200

Automation performance payload returned successfully.

400

Query parameter validation failed.

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 performance metrics failure.

GET /api/v1/automation/performance

cURL

curl -X GET "https://algapsa.com/api/v1/automation/performance?date_from=2026-04-18T15%3A22%3A14Z&date_to=2026-04-18T15%3A22%3A14Z&group_by=hour&rule_ids=string&metrics=string" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/automation/performance?date_from=2026-04-18T15%3A22%3A14Z&date_to=2026-04-18T15%3A22%3A14Z&group_by=hour&rule_ids=string&metrics=string", {
  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/performance?date_from=2026-04-18T15%3A22%3A14Z&date_to=2026-04-18T15%3A22%3A14Z&group_by=hour&rule_ids=string&metrics=string");
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": {
    "_links": {
      "self": "/api/v1/automation/performance",
      "statistics": "/api/v1/automation/statistics"
    }
  }
}