Autional Autional
API Reference GitHub autional.com →

GET /announcements/{announcement_id}/stats

Get read/delivery statistics for a specified announcement. Reference: CAN-SPAM Act (15 U.S.C. §7701) — Commercial Email Compliance.

Notification Service `bearerAuth` application/json

Request Parameters

NameInTypeRequiredDefaultExampleConstraintsDescription
id path string Yes Announcement ID

Responses

StatusDescriptionSchema
200Statistics resultdto.AnnouncementStatsDetailResponse
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.AnnouncementStatsDetailResponse

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

dto.AnnouncementStatsResponse

Announcement read statistics

FieldTypeRequiredExampleConstraintsDescription
dismissals integer No 5
views integer No 100

gitee_com_linmes_authms_base_dto.SimpleResponse

FieldTypeRequiredExampleConstraintsDescription
code integer No
message string No
timestamp string No