コンテンツにスキップ

Get Email Send History

GET
/admin/history

Returns a maximum of 10 items per request

Authorizations

Parameters

Query Parameters

offset
integer

Responses

200

Successful Operation

object
list
required

List of history entries

Array<object>
object
id
required

Unique identifier for the history entry

string
example-string-id
subject
required

Subject of the sent email

string
Weekly Newsletter #42
sent_at
required

Date and time when the email was sent (ISO 8601 format)

string
2024-08-04T12:00:00Z
error

Error name if an error occurs

string | null
Validation Error
errors

List of errar details

array | null
object
field
required

Name of the field where the error occurred

string
message
required

Error message

string
emails

List of events related to the email sending

array | null
object
email
required

Email address of the recipient

string format: email
type
required

Type of event. e.g. “Delivered” “Bounced” “Blocked” “Complaint”

string
Delivered
open
required

Indicates whether the email was opened

boolean
true
marketing
required

Flag indicating if this is a marketing email

boolean
true
length
required

Total number of history entries in the list

integer
10

401

Auth exception

object
error
required

Error message

string
Auth Error

429

Rate limits exceeded