Get Account Metrics

GET

api

metrics

Get Account Metrics

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

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

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

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

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

{
  "success": true,
  "period": "7d",
  "subscriberCount": 12400,
  "activeSubscriberCount": 11880,
  "stats": {
    "sent": 3400,
    "delivered": 3380,
    "bounced": 20,
    "opened": 1020,
    "clicked": 340,
    "replies": 68,
    "unsubscribed": 5,
    "rateDenominator": 3380,
    "rateDenominatorBasis": "delivered",
    "deliveryRate": 99.41,
    "bounceRate": 0.59,
    "openRate": 30.18,
    "clickRate": 10.06,
    "replyRate": 2.01,
    "unsubscribeRate": 0.15
  },
  "commerceForecast": {
    "status": "ready",
    "modelVersion": "cohort-rfm-v1",
    "currency": "USD",
    "confidence": "medium",
    "history": {
      "orderCount": 84,
      "customerCount": 51,
      "repeatCustomerCount": 18,
      "historyDays": 180,
      "daysSinceLastOrder": 1,
      "excludedCurrencyOrderCount": 0
    },
    "forecast": {
      "predictedAverageOrderValueCents": 7200,
      "predictedCustomerValue365DaysCents": 18400,
      "expectedOrders90Days": 68.5,
      "expectedRevenue90DaysCents": 493200
    }
  }
}

{
  "success": false,
  "error": "Invalid period. Must be one of: 1h, 24h, 7d, 30d, 90d"
}

{
  "success": false,
  "error": "Invalid emailType. Must be one of: campaign, transactional, sequence"
}

{ "success": false, "error": "Unauthorized" }

{ "success": false, "error": "Internal server error" }

Returns aggregated email engagement metrics (sends, deliveries, bounces, opens, clicks, replies, unsubscribes) across your entire account for a given time period, plus a live audience snapshot in top-level subscriberCount (every stored contact) and activeSubscriberCount (status=active). Those two fields are independent of period / start / end. Set emailType=transactional to isolate Send API and transactional SMTP traffic, including both direct and saved-template sends. Test sends are excluded from these performance metrics by default so previews do not skew results, but they still count toward send usage and quota. Open and click metrics also exclude detected email-security scanners and tracked brand assets by default. When no emailType filter is used, the optional top-level commerceForecast is calculated separately from the requested email period and served from the latest background-computed snapshot. It uses up to two years of provider-neutral ecommerce.order_placed history and returns predicted AOV, predicted 12-month customer value, expected 90-day orders and revenue, confidence ranges, and the exact eligibility reasons when a store is still learning. Forecasts require at least 20 orders, 10 customers, 30 days of history, 3 repeat customers, and a recent order within 45 days. The field is omitted when no snapshot is available or the analytics store is temporarily unavailable; insufficient_data only describes a successfully evaluated store that has not met the requirements above. GET /api/v1/stats is kept as a backward-compatible alias for this endpoint.

Query Parameters

string

Sliding time window. One of: 1h, 24h, 7d, 30d, 90d. Ignored when start and end are provided.

string

Start of custom time range (ISO 8601, e.g. 2026-02-01T00:00:00Z). Must be used with end.

string

End of custom time range (ISO 8601, e.g. 2026-02-14T00:00:00Z). Must be used with start. Max range: 90 days.

string

Optional structural traffic filter. One of: campaign, transactional, or sequence. Use transactional for Send API and transactional SMTP metrics.

string

Optional recipient mailbox provider filter, e.g. gmail, microsoft, yahoo, icloud, orange. Scopes engagement metrics to recipients whose address is classified to that provider. Provider-filtered responses report replies as 0 (replies cannot be segmented per provider) and omit the commerce forecast. Events recorded before provider classification existed are excluded while this filter is active.

boolean

default:"false"

Set to true to include detected scanner, preview, and tracked asset open/click events in engagement metrics.

How the period is applied

These metrics are a funnel over the sends made inside the period, not a log of events that happened inside it.

sent counts the emails sent between start and end.
Every other count is attributed to one of those sends. An open that arrives three days after the send still counts toward the period the send belongs to, and an open that arrives today for an email sent last month does not.
replies follows the same rule, so replyRate divides replies earned by the period’s sends by that same cohort rather than by whatever happened to arrive in the calendar window.
opened and clicked are unique counts deduplicated by email send. One recipient opening the same email five times counts once. They are not totals of open events.

Because of this, opened <= delivered <= sent always holds and no rate can exceed 100%. Activity on sends that predate the period is excluded rather than counted against a smaller sent figure.

Response Fields

Field	Type	Description
`sent`	`number`	Emails sent in the period
`delivered`	`number`	Emails delivered (capped at sent)
`bounced`	`number`	Emails that bounced
`opened`	`number`	Unique opens (deduplicated by email send)
`clicked`	`number`	Unique clicks (deduplicated by email send)
`replies`	`number`	Inbound replies captured for the period’s sends
`unsubscribed`	`number`	Unsubscribes attributed to the period’s sends
`rateDenominator`	`number`	The number every engagement rate below divides by
`rateDenominatorBasis`	`string`	Which field `rateDenominator` came from: `delivered`, `sent`, or `none`
`deliveryRate`	`number`	Delivery rate percentage (delivered / sent)
`bounceRate`	`number`	Bounce rate percentage (bounced / sent)
`openRate`	`number`	Open rate percentage (opened / `rateDenominator`)
`clickRate`	`number`	Click rate percentage (clicked / `rateDenominator`)
`replyRate`	`number`	Reply rate percentage (replies / `rateDenominator`)
`unsubscribeRate`	`number`	Unsubscribe rate percentage (unsubscribed / `rateDenominator`)

rateDenominator is delivered, falling back to sent when no delivery events were recorded, and 0 when nothing was sent. It is returned so you can reproduce any rate exactly instead of guessing the denominator.

Commerce forecast

This optional object is omitted when a current forecast snapshot is unavailable.

Field	Type	Description
`commerceForecast.status`	`string`	`ready` or `insufficient_data`
`commerceForecast.currency`	`string \| null`	Primary order currency used by the forecast
`commerceForecast.confidence`	`string \| null`	`low`, `medium`, or `high` when ready
`commerceForecast.history`	`object`	Order, customer, repeat, freshness, and history counts
`commerceForecast.actual`	`object`	Observed AOV, customer value, and repeat rate
`commerceForecast.forecast.predictedAverageOrderValueCents`	`number`	Predicted order value in minor currency units
`commerceForecast.forecast.predictedCustomerValue365DaysCents`	`number`	Predicted 12-month customer value
`commerceForecast.forecast.expectedOrders90Days`	`number`	Expected order count over the next 90 days
`commerceForecast.forecast.expectedRevenue90DaysCents`	`number`	Expected revenue over the next 90 days
`commerceForecast.eligibility.reasons`	`array`	Requirements that prevent a forecast from running

Common Queries

How many subscribers do we have?

curl "https://api.sequenzy.com/api/v1/metrics?period=7d" \
 -H "Authorization: Bearer YOUR_API_KEY"

Read top-level subscriberCount and activeSubscriberCount. They are a live audience snapshot and do not change with period.

How many emails did we send in the last 7 days?

curl "https://api.sequenzy.com/api/v1/metrics?period=7d" \
 -H "Authorization: Bearer YOUR_API_KEY"

Check the sent field in the response.

What’s our overall open rate this month?

curl "https://api.sequenzy.com/api/v1/metrics?start=2026-02-01T00:00:00Z&end=2026-02-28T00:00:00Z" \
 -H "Authorization: Bearer YOUR_API_KEY"

Check the openRate field. It is calculated as opened / rateDenominator, where rateDenominator is delivered (or sent when no delivery events were recorded). Both are returned so you can verify the arithmetic.

How are we doing in the last 24 hours?

curl "https://api.sequenzy.com/api/v1/metrics?period=24h" \
 -H "Authorization: Bearer YOUR_API_KEY"

Useful for daily monitoring dashboards or Slack alerts.

What are our Send API open and click rates?

curl "https://api.sequenzy.com/api/v1/metrics?period=30d&emailType=transactional" \
 -H "Authorization: Bearer YOUR_API_KEY"

The response includes opened, clicked, openRate, and clickRate for transactional-origin messages. To inspect one delivery, use its emailSendId with GET /api/v1/email-sends/{emailSendId}. To find IDs by subject, recipient, or delivery status, use GET /api/v1/email-sends. For one saved transactional email’s aggregate rates, use GET /api/v1/metrics/transactional/{idOrSlug}.

Sync daily metrics to our data warehouse

Use fixed time ranges to pull yesterday’s metrics on a cron schedule:

curl "https://api.sequenzy.com/api/v1/metrics?start=2026-02-13T00:00:00Z&end=2026-02-14T00:00:00Z" \
 -H "Authorization: Bearer YOUR_API_KEY"

Fixed ranges are idempotent — safe to retry without double-counting.

Responses

{
  "success": true,
  "period": "7d",
  "subscriberCount": 12400,
  "activeSubscriberCount": 11880,
  "stats": {
    "sent": 3400,
    "delivered": 3380,
    "bounced": 20,
    "opened": 1020,
    "clicked": 340,
    "replies": 68,
    "unsubscribed": 5,
    "rateDenominator": 3380,
    "rateDenominatorBasis": "delivered",
    "deliveryRate": 99.41,
    "bounceRate": 0.59,
    "openRate": 30.18,
    "clickRate": 10.06,
    "replyRate": 2.01,
    "unsubscribeRate": 0.15
  },
  "commerceForecast": {
    "status": "ready",
    "modelVersion": "cohort-rfm-v1",
    "currency": "USD",
    "confidence": "medium",
    "history": {
      "orderCount": 84,
      "customerCount": 51,
      "repeatCustomerCount": 18,
      "historyDays": 180,
      "daysSinceLastOrder": 1,
      "excludedCurrencyOrderCount": 0
    },
    "forecast": {
      "predictedAverageOrderValueCents": 7200,
      "predictedCustomerValue365DaysCents": 18400,
      "expectedOrders90Days": 68.5,
      "expectedRevenue90DaysCents": 493200
    }
  }
}

{
  "success": false,
  "error": "Invalid period. Must be one of: 1h, 24h, 7d, 30d, 90d"
}

{
  "success": false,
  "error": "Invalid emailType. Must be one of: campaign, transactional, sequence"
}

{ "success": false, "error": "Unauthorized" }

{ "success": false, "error": "Internal server error" }

Get Account Metrics

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

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

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

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

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

{
  "success": true,
  "period": "7d",
  "subscriberCount": 12400,
  "activeSubscriberCount": 11880,
  "stats": {
    "sent": 3400,
    "delivered": 3380,
    "bounced": 20,
    "opened": 1020,
    "clicked": 340,
    "replies": 68,
    "unsubscribed": 5,
    "rateDenominator": 3380,
    "rateDenominatorBasis": "delivered",
    "deliveryRate": 99.41,
    "bounceRate": 0.59,
    "openRate": 30.18,
    "clickRate": 10.06,
    "replyRate": 2.01,
    "unsubscribeRate": 0.15
  },
  "commerceForecast": {
    "status": "ready",
    "modelVersion": "cohort-rfm-v1",
    "currency": "USD",
    "confidence": "medium",
    "history": {
      "orderCount": 84,
      "customerCount": 51,
      "repeatCustomerCount": 18,
      "historyDays": 180,
      "daysSinceLastOrder": 1,
      "excludedCurrencyOrderCount": 0
    },
    "forecast": {
      "predictedAverageOrderValueCents": 7200,
      "predictedCustomerValue365DaysCents": 18400,
      "expectedOrders90Days": 68.5,
      "expectedRevenue90DaysCents": 493200
    }
  }
}

{
  "success": false,
  "error": "Invalid period. Must be one of: 1h, 24h, 7d, 30d, 90d"
}

{
  "success": false,
  "error": "Invalid emailType. Must be one of: campaign, transactional, sequence"
}

{ "success": false, "error": "Unauthorized" }

{ "success": false, "error": "Internal server error" }

​Query Parameters

​How the period is applied

​Response Fields

​Commerce forecast

​Common Queries

​How many subscribers do we have?

​How many emails did we send in the last 7 days?

​What’s our overall open rate this month?

​How are we doing in the last 24 hours?

​What are our Send API open and click rates?

​Sync daily metrics to our data warehouse

​Responses

Query Parameters

How the period is applied

Response Fields

Commerce forecast

Common Queries

How many subscribers do we have?

How many emails did we send in the last 7 days?

What’s our overall open rate this month?

How are we doing in the last 24 hours?

What are our Send API open and click rates?

Sync daily metrics to our data warehouse

Responses