Get Campaign Metrics

GET

api

metrics

campaigns

{campaignId}

Get Campaign Metrics

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

import requests

url = "https://api.sequenzy.com/api/v1/metrics/campaigns/{campaignId}"

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/campaigns/{campaignId}', 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/campaigns/{campaignId}",
  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/campaigns/{campaignId}"

	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/campaigns/{campaignId}")

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,
  "campaignId": "camp_abc123",
  "stats": {
    "sent": 1200,
    "delivered": 1190,
    "bounced": 10,
    "opened": 420,
    "clicked": 85,
    "replies": 24,
    "unsubscribed": 2,
    "deliveryRate": 99.17,
    "bounceRate": 0.83,
    "openRate": 35.29,
    "clickRate": 7.14,
    "replyRate": 2.02,
    "unsubscribeRate": 0.17,
    "conversions": 12,
    "revenueCents": 84500
  },
  "clickedLinks": [
    {
      "url": "https://example.com/pricing?utm_source=email",
      "clicks": 52,
      "percentage": 61.18
    },
    {
      "url": "https://example.com/blog/launch",
      "clicks": 33,
      "percentage": 38.82
    }
  ],
  "polls": [
    {
      "blockId": "poll-nps-1",
      "variant": "nps",
      "question": "How likely are you to recommend us?",
      "attributeKey": "nps_score",
      "totalResponses": 3,
      "answers": [
        { "answer": "0", "value": "0", "responses": 1, "percentage": 33.3 },
        { "answer": "1", "value": "1", "responses": 0, "percentage": 0 },
        { "answer": "2", "value": "2", "responses": 0, "percentage": 0 },
        { "answer": "3", "value": "3", "responses": 0, "percentage": 0 },
        { "answer": "4", "value": "4", "responses": 0, "percentage": 0 },
        { "answer": "5", "value": "5", "responses": 0, "percentage": 0 },
        { "answer": "6", "value": "6", "responses": 0, "percentage": 0 },
        { "answer": "7", "value": "7", "responses": 0, "percentage": 0 },
        { "answer": "8", "value": "8", "responses": 0, "percentage": 0 },
        { "answer": "9", "value": "9", "responses": 2, "percentage": 66.7 },
        { "answer": "10", "value": "10", "responses": 0, "percentage": 0 }
      ],
      "nps": {
        "score": 33,
        "average": 6,
        "promoters": 2,
        "passives": 0,
        "detractors": 1
      }
    }
  ]
}

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

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

{ "success": false, "error": "Campaign not found" }

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

Returns engagement metrics (sends, deliveries, bounces, opens, clicks, replies, unsubscribes) plus attributed conversions, revenue, a per-link click breakdown, and any Poll or NPS survey summaries for a single campaign. Optionally filter engagement metrics by time period. Test sends are excluded from these performance metrics, attributed revenue, and poll results 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. GET /api/v1/campaigns/{campaignId}/stats is kept as a backward-compatible alias for this endpoint.

Path Parameters

string

required

The ID of the campaign.

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). Must be used with end.

string

End of custom time range (ISO 8601). Must be used with start. Max range: 90 days.

string

Optional recipient mailbox provider filter, e.g. gmail, microsoft, yahoo, icloud, orange. Scopes engagement metrics and the clicked-link breakdown to recipients whose address is classified to that provider. Provider-filtered responses report replies, conversions, and revenueCents as 0 because those metrics cannot be segmented per provider.

boolean

default:"false"

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

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. sent 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 opened <= delivered <= sent always holds and no rate can exceed 100%. conversions and revenueCents are the exception: they use the goal’s own last-touch attribution window rather than the send cohort. opened and clicked are unique counts deduplicated by email send: one recipient opening the same email five times counts once. Rates divide by rateDenominator (delivered, falling back to sent), which is returned alongside rateDenominatorBasis so you can reproduce the arithmetic.

Response Fields

Field	Type	Description
`sent`	`number`	Emails sent in the period
`delivered`	`number`	Emails delivered
`bounced`	`number`	Emails that bounced
`opened`	`number`	Unique opens
`clicked`	`number`	Unique clicks
`replies`	`number`	Inbound replies captured for this campaign
`unsubscribed`	`number`	Unsubscribes
`deliveryRate`	`number`	Delivery rate percentage
`bounceRate`	`number`	Bounce rate percentage
`openRate`	`number`	Open rate percentage
`clickRate`	`number`	Click rate percentage
`replyRate`	`number`	Reply rate percentage
`unsubscribeRate`	`number`	Unsubscribe rate percentage
`rateDenominator`	`number`	The number every engagement rate divides by
`rateDenominatorBasis`	`string`	Which field `rateDenominator` came from: `delivered`, `sent`, or `none`
`conversions`	`number`	Goal conversions attributed to this campaign (last-touch, 24h window)
`revenueCents`	`number`	Attributed revenue in cents from purchase events (`saas.purchase` and `ecommerce.order_placed`)
`clickedLinks`	`array`	Top-level per-link click breakdown; omitted when the campaign has no tracked link clicks
`polls`	`array`	Top-level Poll/NPS summaries; omitted when the campaign has no responses

Each clickedLinks item includes the destination url, the number of clicks on it, and percentage - that link’s share of every recorded link click. Links are ordered by click count and capped at the top 20. Like polls, the breakdown covers the campaign’s lifetime clicks even when engagement metrics are filtered with period, start, or end. Scanner and asset clicks are excluded unless includeMachineEngagement=true. Each polls item includes blockId, variant, question, attributeKey, totalResponses, and an answers distribution. Every answer includes its human-readable answer label and stable stored value; use value as the identifier when labels can change. NPS items also include nps.score, nps.average, and promoter/passive/detractor counts. Single-answer polls count each subscriber once per block using their latest answer. Multi-select polls additionally set allowMultiple: true, count each subscriber once under every option in their latest saved selection, and use the number of respondents as totalResponses, so answer percentages can add up past 100%. Poll summaries are lifetime results for the campaign even when engagement metrics are filtered with period, start, or end. attributeKey is where each subscriber’s current/latest response is stored. A later poll can overwrite it when the same key is reused, so it is not a historical respondent identifier. To find the exact subscribers behind a campaign count, create a segment with field pollResponse, operator is, and a JSON value scoped to this campaign and the summary’s blockId:

{
  "v": 1,
  "campaignId": "camp_abc123",
  "blockId": "poll_1",
  "match": { "kind": "answer", "value": "loved" }
}

For an NPS split, use match value {"kind":"npsBucket","bucket":"detractors"}; the other buckets are promoters and passives.

Common Queries

curl "https://api.sequenzy.com/api/v1/metrics/campaigns/camp_abc123" \
 -H "Authorization: Bearer YOUR_API_KEY"

Without time filters, you get lifetime metrics for the campaign.

How many opens in the first 24 hours after send?

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

Useful to gauge initial engagement before the campaign matures.

Compare campaign performance over a specific week

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

Who opened or clicked in this campaign?

Use the Get Recipients endpoint with a campaignId filter to see individual recipient engagement:

curl "https://api.sequenzy.com/api/v1/metrics/recipients?campaignId=camp_abc123" \
 -H "Authorization: Bearer YOUR_API_KEY"

Responses

{
  "success": true,
  "campaignId": "camp_abc123",
  "stats": {
    "sent": 1200,
    "delivered": 1190,
    "bounced": 10,
    "opened": 420,
    "clicked": 85,
    "replies": 24,
    "unsubscribed": 2,
    "deliveryRate": 99.17,
    "bounceRate": 0.83,
    "openRate": 35.29,
    "clickRate": 7.14,
    "replyRate": 2.02,
    "unsubscribeRate": 0.17,
    "conversions": 12,
    "revenueCents": 84500
  },
  "clickedLinks": [
    {
      "url": "https://example.com/pricing?utm_source=email",
      "clicks": 52,
      "percentage": 61.18
    },
    {
      "url": "https://example.com/blog/launch",
      "clicks": 33,
      "percentage": 38.82
    }
  ],
  "polls": [
    {
      "blockId": "poll-nps-1",
      "variant": "nps",
      "question": "How likely are you to recommend us?",
      "attributeKey": "nps_score",
      "totalResponses": 3,
      "answers": [
        { "answer": "0", "value": "0", "responses": 1, "percentage": 33.3 },
        { "answer": "1", "value": "1", "responses": 0, "percentage": 0 },
        { "answer": "2", "value": "2", "responses": 0, "percentage": 0 },
        { "answer": "3", "value": "3", "responses": 0, "percentage": 0 },
        { "answer": "4", "value": "4", "responses": 0, "percentage": 0 },
        { "answer": "5", "value": "5", "responses": 0, "percentage": 0 },
        { "answer": "6", "value": "6", "responses": 0, "percentage": 0 },
        { "answer": "7", "value": "7", "responses": 0, "percentage": 0 },
        { "answer": "8", "value": "8", "responses": 0, "percentage": 0 },
        { "answer": "9", "value": "9", "responses": 2, "percentage": 66.7 },
        { "answer": "10", "value": "10", "responses": 0, "percentage": 0 }
      ],
      "nps": {
        "score": 33,
        "average": 6,
        "promoters": 2,
        "passives": 0,
        "detractors": 1
      }
    }
  ]
}

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

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

{ "success": false, "error": "Campaign not found" }

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

Get Campaign Metrics

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

import requests

url = "https://api.sequenzy.com/api/v1/metrics/campaigns/{campaignId}"

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/campaigns/{campaignId}', 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/campaigns/{campaignId}",
  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/campaigns/{campaignId}"

	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/campaigns/{campaignId}")

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,
  "campaignId": "camp_abc123",
  "stats": {
    "sent": 1200,
    "delivered": 1190,
    "bounced": 10,
    "opened": 420,
    "clicked": 85,
    "replies": 24,
    "unsubscribed": 2,
    "deliveryRate": 99.17,
    "bounceRate": 0.83,
    "openRate": 35.29,
    "clickRate": 7.14,
    "replyRate": 2.02,
    "unsubscribeRate": 0.17,
    "conversions": 12,
    "revenueCents": 84500
  },
  "clickedLinks": [
    {
      "url": "https://example.com/pricing?utm_source=email",
      "clicks": 52,
      "percentage": 61.18
    },
    {
      "url": "https://example.com/blog/launch",
      "clicks": 33,
      "percentage": 38.82
    }
  ],
  "polls": [
    {
      "blockId": "poll-nps-1",
      "variant": "nps",
      "question": "How likely are you to recommend us?",
      "attributeKey": "nps_score",
      "totalResponses": 3,
      "answers": [
        { "answer": "0", "value": "0", "responses": 1, "percentage": 33.3 },
        { "answer": "1", "value": "1", "responses": 0, "percentage": 0 },
        { "answer": "2", "value": "2", "responses": 0, "percentage": 0 },
        { "answer": "3", "value": "3", "responses": 0, "percentage": 0 },
        { "answer": "4", "value": "4", "responses": 0, "percentage": 0 },
        { "answer": "5", "value": "5", "responses": 0, "percentage": 0 },
        { "answer": "6", "value": "6", "responses": 0, "percentage": 0 },
        { "answer": "7", "value": "7", "responses": 0, "percentage": 0 },
        { "answer": "8", "value": "8", "responses": 0, "percentage": 0 },
        { "answer": "9", "value": "9", "responses": 2, "percentage": 66.7 },
        { "answer": "10", "value": "10", "responses": 0, "percentage": 0 }
      ],
      "nps": {
        "score": 33,
        "average": 6,
        "promoters": 2,
        "passives": 0,
        "detractors": 1
      }
    }
  ]
}

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

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

{ "success": false, "error": "Campaign not found" }

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

​Path Parameters

​Query Parameters

​How a period is applied

​Response Fields

​Common Queries

​How did our February newsletter perform?

​How many opens in the first 24 hours after send?

​Compare campaign performance over a specific week

​Who opened or clicked in this campaign?

​Responses

Path Parameters

Query Parameters

How a period is applied

Response Fields

Common Queries

How did our February newsletter perform?

How many opens in the first 24 hours after send?

Compare campaign performance over a specific week

Who opened or clicked in this campaign?

Responses