Autional Autional
API Reference GitHub autional.com →

GET /notifications/stats

Get aggregated statistics of notification sending, delivery, and reading for the current tenant. Reference: CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance.

Notification Service `bearerAuth` application/json

Responses

StatusDescriptionSchema
200Statistics resultdto.NotificationStatsDetailResponse
400Invalid request parametersgitee_com_linmes_authms_base_dto.SimpleResponse
401Unauthenticatedgitee_com_linmes_authms_base_dto.SimpleResponse
403Insufficient permissionsgitee_com_linmes_authms_base_dto.SimpleResponse
404Resource not foundgitee_com_linmes_authms_base_dto.SimpleResponse
500Internal server errorgitee_com_linmes_authms_base_dto.SimpleResponse

Referenced Schemas

dto.NotificationStatsDetailResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
data dto.NotificationStatsResponse No
message string No
timestamp string No

dto.NotificationStatsResponse

Notification send and read statistics (notification layer does not track delivery status, only read/unread)

FieldTypeRequiredExampleConstraintsDescription
by_type object No extra keys: `integer` By type
read_rate number No 0.45 Read rate
total_read integer No 450 Total read
total_sent integer No 1000 Total sent

gitee_com_linmes_authms_base_dto.SimpleResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
message string No
timestamp string No
Try this API in Scalar → Download OpenAPI spec (JSON) ↓