GET

api

metrics

transactional

{idOrSlug}

Get Transactional Email Metrics

curl --request GET \
  --url https://api.sequenzy.com/api/v1/metrics/transactional/{idOrSlug} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sequenzy.com/api/v1/metrics/transactional/{idOrSlug}"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/metrics/transactional/{idOrSlug}', 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://api.sequenzy.com/api/v1/metrics/transactional/{idOrSlug}",
  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://api.sequenzy.com/api/v1/metrics/transactional/{idOrSlug}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/metrics/transactional/{idOrSlug}")

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

Get Transactional Email Metrics

Returns aggregate metrics for one saved transactional email selected by its ID or API slug. Results are all-time by default. Open and click metrics exclude detected machine engagement unless includeMachineEngagement=true is used. The explicit engagementBreakdown always returns both human and machine counts. Bounce types use the latest bounce event for each delivery, so permanent, transient, and undetermined counts are mutually exclusive. Direct-content Send API messages do not have a stable template identity. Use account metrics with emailType=transactional, then search recent deliveries through GET /api/v1/email-sends and inspect one by ID. GET /api/v1/transactional/{idOrSlug}/stats is a compatibility alias.

How a period is applied

When you filter with period or start/end, the response is a funnel over the sends made inside that window, not a log of events that happened inside it. sends counts those sends, and every delivery, engagement, and reply count is attributed to one of them - including a reply or an open that arrives after the window closes. Activity on sends that predate the window is excluded, so opens <= deliveries <= sends always holds and no rate can exceed 100%. opens and clicks are unique counts deduplicated by email send: one recipient opening the same email five times counts once.

Parameters

string

required

Saved transactional email ID or API slug.

string

Optional sliding window: 1h, 24h, 7d, 30d, or 90d.

string

ISO 8601 custom range start. Must be used with end.

string

ISO 8601 custom range end. Must be used with start; maximum 90 days.

boolean

default:"false"

Include detected scanners, previews, and tracked asset engagement.

curl "https://api.sequenzy.com/api/v1/metrics/transactional/password-reset?period=30d" \
  -H "Authorization: Bearer API_KEY"

200

{
  "success": true,
  "period": "30d",
  "transactional": {
    "id": "transactional_123",
    "name": "Password reset",
    "slug": "password-reset"
  },
  "stats": {
    "sent": 100,
    "delivered": 98,
    "bounced": 2,
    "opened": 72,
    "clicked": 45,
    "replies": 6,
    "complaints": 1,
    "deliveryRate": 98,
    "bounceRate": 2,
    "openRate": 73.47,
    "clickRate": 45.92,
    "replyRate": 6.12,
    "complaintRate": 1
  },
  "complaints": { "count": 1, "rate": 1 },
  "clickedLinks": [
    {
      "url": "https://example.com/reset",
      "clicks": 40,
      "percentage": 88.89
    }
  ],
  "bounceBreakdown": {
    "permanent": 1,
    "transient": 1,
    "undetermined": 0,
    "subtypes": [
      { "type": "Permanent", "subType": "General", "count": 1 },
      { "type": "Transient", "subType": "MailboxFull", "count": 1 }
    ]
  },
  "engagementBreakdown": {
    "human": { "opens": 72, "clicks": 45 },
    "machine": { "opens": 8, "clicks": 2 }
  }
}

Get Transactional Email Metrics

curl --request GET \
  --url https://api.sequenzy.com/api/v1/metrics/transactional/{idOrSlug} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sequenzy.com/api/v1/metrics/transactional/{idOrSlug}"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/metrics/transactional/{idOrSlug}', 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://api.sequenzy.com/api/v1/metrics/transactional/{idOrSlug}",
  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://api.sequenzy.com/api/v1/metrics/transactional/{idOrSlug}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/metrics/transactional/{idOrSlug}")

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

​Get Transactional Email Metrics

​How a period is applied

​Parameters

Get Transactional Email Metrics

How a period is applied

Parameters