ELelasticemail
Events

Load Events

Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports

get/events

Request

  • Base URL
    https://api.elasticemail.com/v4
  • URL
    https://api.elasticemail.com/v4/events
  • Auth
    API key in header X-ElasticEmail-ApiKey

Query parameters

eventTypesEventType[]

array

Types of Events to return

fromstring date-time nullable

string

Example:2001-01-01T01:01:01

Starting date for search in YYYY-MM-DDThh:mm:ss format.

tostring date-time nullable

string

Example:2001-01-01T01:01:01

Ending date for search in YYYY-MM-DDThh:mm:ss format.

orderBy'DateDescending' | 'DateAscending'
limitinteger

integer

How many items to load. Maximum for this request is 1000 items

offsetinteger

integer

How many items should be returned ahead.

Response

OK

TransactionIDstring string

ID number of transaction

MsgIDstring string

ID number of selected message.

FromEmailstring string

Default From: email address.

Tostring string

Ending date for search in YYYY-MM-DDThh:mm:ss format.

Subjectstring string

Default subject of email.

EventType'Submission' | 'FailedAttempt' | 'Bounce' | 'Sent' | 'Open' | 'Click' | 'Unsubscribe' | 'Complaint'

Type of event

EventDatestring date-time

Creation date

ChannelNamestring string

Name of selected channel.

MessageCategory'Unknown' | 'Ignore' | 'Spam' | 'BlackListed' | 'NoMailbox' | 'GreyListed' | 'Throttled' | 'Timeout' | 'ConnectionProblem' | 'SPFProblem' | 'AccountProblem' | 'DNSProblem' | 'NotDeliveredCancelled' | 'CodeError' | 'ManualCancel' | 'ConnectionTerminated' | 'NotDelivered'
NextTryOnstring date-time nullable

Date of next try

Messagestring string

Content of message, HTML encoded

IPAddressstring string

IP which this email was sent through

PoolNamestring string

Name of an IP pool this email was sent through

Example response

[
  {
    "TransactionID": "TransactionID",
    "MsgID": "ABCDE_9RPhSWiaJq_ab1g1",
    "FromEmail": "sender@yourdomain.com",
    "To": "2001-01-01T01:01:01",
    "Subject": "Hello!",
    "ChannelName": "Channel01",
    "NextTryOn": "2001-01-01T12:00:00",
    "Message": "Lorem ipsum"
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.