Autional Autional
API Reference GitHub autional.com →

GET /communication/dashboard

Get delivery statistics for each communication channel of the current tenant, including total sends, successful deliveries, failures, delivery success rate, and distribution by channel and status. References: ePrivacy Directive 2002/58/EC, CAN-SPAM Act.

Communication Service `bearerAuth` application/json

Request Parameters

NameInTypeRequiredDefaultExampleConstraintsDescription
days query integer No Statistics days range (default 30 days)

Responses

StatusDescriptionSchema
200Query successful, returns tenant communication delivery dashboard datadto.CommunicationDashboardDataResponse
400Invalid request parametersdto.SimpleResponse
401Unauthenticated or invalid tokendto.SimpleResponse
403Insufficient permissions to access this resourcedto.SimpleResponse
500Internal server errordto.SimpleResponse

Referenced Schemas

dto.CommunicationDashboardDataResponse

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

dto.CommunicationDashboardResponse

Communication service delivery statistics by channel

FieldTypeRequiredExampleConstraintsDescription
by_channel object No extra keys: `integer`
by_status object No extra keys: `integer`
delivered integer No 980
delivery_rate number No 0.98
failed integer No 20
total_sent integer No 1000

dto.SimpleResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
message string No
timestamp string No