GET
/dispatch_history/{bucketId} https://apis-spb.konso.io/dispatch_history/{bucketId} Dispatch message history
Параметры запроса
bucketId string Project (bucket) identifier
x-api-key string API key passed in the request header for authentication
email string Filter by recipient email address
subject string Filter by message subject (partial match)
fromDate number Start of date range as Unix timestamp (milliseconds)
toDate number End of date range as Unix timestamp (milliseconds)
tags string Comma-separated list of tags to filter by (e.g. onboarding,welcome)
sort string
по умолчанию: "TimeStampDesc" Sort order: TimeStampAsc or TimeStampDesc. Defaults to TimeStampDesc
from number
по умолчанию: "0" Zero-based offset for pagination
to number
по умолчанию: "10" Maximum number of records to return
Ответы
200 Paginated list of dispatch history records.
тип: PagedApiResponse<DispatchHistoryDto>
401 Unauthorized — API key is missing or invalid.
500 Unexpected server error.
тип: ApiResponse<T>
success boolean Always false errors ErrorDetail[] Server-side errors correlationId string Trace ID message string Error message stack string Stack trace (non-production only) Язык:
expand_more
Пример запроса
curl --request GET \
--url 'https://apis-spb.konso.io/dispatch_history/{bucketId}?from=0&to=20&sort=TimeStampDesc' \
--header 'x-api-key: <your-api-key>' Response Example 200
{
"total": 1,
"list": [
{
"id": "msg_a1b2c3d4e5f6",
"projectId": "my-bucket-id",
"correlationId": "req-abc-123",
"env": "production",
"recipient": "user@example.com",
"subject": "Welcome to Konso",
"createdOn": 1718620800000,
"messageType": 1,
"status": "Sent",
"statusId": 2,
"errorMsg": null,
"providerName": "SendGrid",
"providerId": "prv_xyz789",
"tags": ["onboarding", "welcome"],
"sentOn": 1718620801500
}
]
} KONSO