GET/dispatch_history/{bucketId}

Dispatch message history

Параметры запроса

bucketIdstring

Обязательный

Project (bucket) identifier

x-api-keystring

Обязательный

API key passed in the request header for authentication

emailstring

Необязательный

Filter by recipient email address

subjectstring

Необязательный

Filter by message subject (partial match)

fromDatenumber

Необязательный

Start of date range as Unix timestamp (milliseconds)

toDatenumber

Необязательный

End of date range as Unix timestamp (milliseconds)

tagsstring

Необязательный

Comma-separated list of tags to filter by (e.g. onboarding,welcome)

sortstringпо умолчанию: "TimeStampDesc"

Необязательный

Sort order: TimeStampAsc or TimeStampDesc. Defaults to TimeStampDesc

fromnumberпо умолчанию: "0"

Необязательный

Zero-based offset for pagination

tonumberпо умолчанию: "10"

Необязательный

Maximum number of records to return

Ответы

200Paginated list of dispatch history records.

тип: PagedApiResponse<DispatchHistoryDto>

401Unauthorized — API key is missing or invalid.

500Unexpected server error.

тип: ApiResponse<T>

successbooleanAlways false

errorsErrorDetail[]Server-side errors

correlationIdstringTrace ID

messagestringError message

stackstringStack 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 Example200

{
  "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