Skip to content
SupaCloud Docs
Select themeSelect language

`GET /api/reports/schedules/deliveries/stats` — the workspace-wide send KPIs (`sent` / `failed`) from the `report_schedule_deliveries` log, plus the newest failures with the reason each carries (#874 / RP-7). The former third KPI ("Delivered") was the same count as `sent` and is gone (#874 / RP-6).

GET
/api/reports/schedules/deliveries/stats
curl --request GET \
  --url https://example.com/api/reports/schedules/deliveries/stats \
  --cookie supacloud_session=<supacloud_session>

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Workspace report-delivery KPIs.

Media typeapplication/json

The send KPIs over all schedules in a workspace (#626 §11) plus the newest failures behind the failed count.

#874 — two honesty fixes live in this shape:

  • The third KPI (“Delivered”) is GONE. It was the same status='sent' SQL FILTER as sent, rendered under a second label, so it read as an independent delivery confirmation that never existed (RP-6).
  • recent_failures is the missing READ path for report_schedule_deliveries.error (RP-7). “Failed: 3” with no way to learn which schedule or why is barely better than silence.
object
failed
required
integer format: int64
recent_failures
required
Array<object>

One failed delivery attempt, surfaced next to the KPI counts (#874 / RP-7).

object
channel
required

email | discord | telegram | in_app.

string
error

The recorded reason. Always populated for a failure row written since #874; None only for a pre-existing row.

string | null
fired_at
required
string format: date-time
schedule_id
required
string format: uuid
schedule_name
required
string
sent
required
integer format: int64
Examplegenerated
{
  "failed": 1,
  "recent_failures": [
    {
      "channel": "example",
      "error": "example",
      "fired_at": "2026-04-15T12:00:00Z",
      "schedule_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "schedule_name": "example"
    }
  ],
  "sent": 1
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

403

Section titled “403”

Permission denied

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden license_required license_expired bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited too_many_requests quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}