Skip to main content
GET
/
events
Returns all logged email events
curl --request GET \
  --url https://console.sendlayer.com/api/v1/events \
  --header 'Authorization: Bearer <token>'
{
  "TotalRecords": 1,
  "Events": [
    {
      "Event": "opened",
      "LoggedAt": 1658326035,
      "LogLevel": "info",
      "Message": {
        "Headers": {
          "MessageId": "70e80563-4e08-4313-9b8b-ad56449bfbb6",
          "From": [
            "[email protected]"
          ],
          "ReplyTo": [
            {}
          ],
          "To": [
            "Pattie Paloma, [email protected]"
          ],
          "Cc": [
            {}
          ],
          "Bcc": [
            {}
          ],
          "Subject": "<string>"
        }
      },
      "Reason": "Email opened.",
      "Ip": "10.30.126.18",
      "Geolocation": {
        "City": "<string>",
        "Region": "<string>",
        "Country": "<string>"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
StartDate
number

Unix Timestamp

Example:

1646901478

​
EndDate
number

Unix Timestamp

Example:

1646901480

​
Event
string

Name of event type (accepted, rejected, failed, delivered, opened, clicked, unsubscribed, complained)

Example:

"delivered"

​
StartFrom
number
Required range: x >= 0
Example:

0

​
RetrieveCount
number
Required range: x >= 1
Example:

20

​
MessageID
string
Example:

"10210a3d-7d37-4967-9c20-ad4e26016a78"

Response

200 - application/json

OK

A succesful response returns records for the logged email event(s)

​
TotalRecords
integer
Example:

1

​
Events
object[]