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>'
import requests

url = "https://console.sendlayer.com/api/v1/events"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://console.sendlayer.com/api/v1/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://console.sendlayer.com/api/v1/events",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://console.sendlayer.com/api/v1/events"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://console.sendlayer.com/api/v1/events")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://console.sendlayer.com/api/v1/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "TotalRecords": 1,
  "Events": [
    {
      "Event": "opened",
      "LoggedAt": 1658326035,
      "LogLevel": "info",
      "Message": {
        "Headers": {
          "MessageId": "70e80563-4e08-4313-9b8b-ad56449bfbb6",
          "From": [
            "paulie@example.com"
          ],
          "ReplyTo": [
            {}
          ],
          "To": [
            "Pattie Paloma, pattie@exampledomain.com"
          ],
          "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[]