Get client stats

Client statistics route with explicit API-key validation and client:read permission check.

RBAC · client

Response body

Success response 200 · schema ClientStatsEnvelope

dataobjectRequired

total_clientsnumberRequired

active_clientsnumberRequired

inactive_clientsnumberRequired

clients_by_billing_cycleobjectRequired

clients_by_client_typeobjectRequired

total_credit_balancenumberRequired

average_credit_balancenumberRequired

metaobject

Response codes

200

Client stats returned.

401

API key missing/invalid or key user not found.

403

Permission denied for client read.

500

Unexpected client stats failure.

GET /api/v1/clients/stats

cURL

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

TypeScript

const response = await fetch("https://algapsa.com/api/v1/clients/stats", {
  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/clients/stats");
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_clients": 0,
    "active_clients": 0,
    "inactive_clients": 0,
    "clients_by_billing_cycle": {},
    "clients_by_client_type": {},
    "total_credit_balance": 0,
    "average_credit_balance": 0
  },
  "meta": {}
}