Get A/B Test Stats

GET

api

ab-tests

{abTestId}

stats

Get A/B Test Stats

curl --request GET \
  --url https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/stats \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/stats', 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/ab-tests/{abTestId}/stats",
  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/ab-tests/{abTestId}/stats"

	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/ab-tests/{abTestId}/stats")

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,
  "abTestId": "ab_abc123",
  "period": "30d",
  "stats": {
    "sent": 200,
    "delivered": 198,
    "opened": 92,
    "clicked": 18,
    "openRate": 46.46,
    "clickRate": 9.09
  },
  "variants": [
    {
      "id": "var_a",
      "label": "A",
      "subject": "Welcome",
      "isWinner": false,
      "stats": {
        "sent": 100,
        "delivered": 99,
        "opened": 42,
        "clicked": 7,
        "openRate": 42.42,
        "clickRate": 7.07
      }
    },
    {
      "id": "var_b",
      "label": "B",
      "subject": "Welcome aboard",
      "isWinner": false,
      "stats": {
        "sent": 100,
        "delivered": 99,
        "opened": 50,
        "clicked": 11,
        "openRate": 50.51,
        "clickRate": 11.11
      }
    }
  ],
  "significance": {
    "metric": "open_rate",
    "status": "not_significant",
    "confidenceLevel": 0.95,
    "leaderVariantId": "var_b",
    "leaderVariantLabel": "B",
    "confidence": 0.7457,
    "pValue": 0.2543,
    "relativeLift": 0.1905
  }
}

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

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

{
  "success": false,
  "error": "A/B test not found"
}

Get aggregate A/B test stats and per-variant stats for the authenticated company. Open and click metrics exclude detected email-security scanners and tracked brand assets by default. The response also reports whether the difference in the test’s winner metric (open rate or click rate) is statistically significant, so you can tell a real winner from noise.

Request

string

required

A/B test ID.

string

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

string

Custom range start as ISO 8601. Requires end.

string

Custom range end as ISO 8601. Requires start.

boolean

default:"false"

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

curl "https://api.sequenzy.com/api/v1/ab-tests/ab_abc123/stats?period=30d" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response fields

object

Present when the test is judged on a goal or an event. Covers every send of the test, whatever period, start and end say. convertedRecipients counts recipients with a goal conversion attributed to the variant (see Create A/B test for how attribution works), or who fired the event after their send. conversionRate is that count per delivered email, as a percentage. value is the summed goal value, such as revenue in cents, and refunds lower it. valuePerDelivery divides it by delivered emails. Both are 0 for events.

object

Statistical significance of the test’s winner metric. Before a winner is selected it uses the same time range as the stats. Once a winner is selected, it compares only the emails sent before the winner was chosen, with all of their later opens and clicks, and ignores period, start and end: the winner’s later sends to the rest of the audience are counted under its variant and would skew the comparison. For a sequence test whose winner you later changed or resumed, the comparison also includes the earlier winner’s sends. The leading variant is compared with every other variant using a two-sided two-proportion z-test, corrected for the number of comparisons. Rates use delivered emails, or sends when no deliveries were recorded.

Show properties

string

The test’s winner criteria: open_rate, click_rate, goal_conversion_rate, goal_value, or event_rate. Goal and event metrics compare the share of recipients who converted. goal_value does too, because value has no yes/no outcome per recipient.

string

insufficient_data when a variant has fewer than 30 recipients or too few opens/clicks for a reliable result, not_significant when the difference could still be chance, or significant when confidence reaches confidenceLevel.

number

Confidence required for significant: 0.95.

string | null

Variant with the highest rate. null when the top variants are tied.

string | null

Label of the leading variant, such as B.

number | null

One minus pValue, from 0 to 1. At or above confidenceLevel, the leader’s advantage over every other variant is unlikely to be chance. Very strong results can round to exactly 1; treat that as above 99.9%. null while status is insufficient_data.

number | null

Corrected two-sided p-value of the weakest leader comparison. null while status is insufficient_data.

number | null

How much higher the leader’s rate is than the closest variant’s (0.3 means 30% higher). null without a leader or when the closest variant has no opens or clicks.

Significance is informational. Automatic winner selection still picks the variant with the highest rate when the test period ends.

Responses

{
  "success": true,
  "abTestId": "ab_abc123",
  "period": "30d",
  "stats": {
    "sent": 200,
    "delivered": 198,
    "opened": 92,
    "clicked": 18,
    "openRate": 46.46,
    "clickRate": 9.09
  },
  "variants": [
    {
      "id": "var_a",
      "label": "A",
      "subject": "Welcome",
      "isWinner": false,
      "stats": {
        "sent": 100,
        "delivered": 99,
        "opened": 42,
        "clicked": 7,
        "openRate": 42.42,
        "clickRate": 7.07
      }
    },
    {
      "id": "var_b",
      "label": "B",
      "subject": "Welcome aboard",
      "isWinner": false,
      "stats": {
        "sent": 100,
        "delivered": 99,
        "opened": 50,
        "clicked": 11,
        "openRate": 50.51,
        "clickRate": 11.11
      }
    }
  ],
  "significance": {
    "metric": "open_rate",
    "status": "not_significant",
    "confidenceLevel": 0.95,
    "leaderVariantId": "var_b",
    "leaderVariantLabel": "B",
    "confidence": 0.7457,
    "pValue": 0.2543,
    "relativeLift": 0.1905
  }
}

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

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

{
  "success": false,
  "error": "A/B test not found"
}

Get A/B Test Stats

curl --request GET \
  --url https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/stats \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.sequenzy.com/api/v1/ab-tests/{abTestId}/stats', 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/ab-tests/{abTestId}/stats",
  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/ab-tests/{abTestId}/stats"

	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/ab-tests/{abTestId}/stats")

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,
  "abTestId": "ab_abc123",
  "period": "30d",
  "stats": {
    "sent": 200,
    "delivered": 198,
    "opened": 92,
    "clicked": 18,
    "openRate": 46.46,
    "clickRate": 9.09
  },
  "variants": [
    {
      "id": "var_a",
      "label": "A",
      "subject": "Welcome",
      "isWinner": false,
      "stats": {
        "sent": 100,
        "delivered": 99,
        "opened": 42,
        "clicked": 7,
        "openRate": 42.42,
        "clickRate": 7.07
      }
    },
    {
      "id": "var_b",
      "label": "B",
      "subject": "Welcome aboard",
      "isWinner": false,
      "stats": {
        "sent": 100,
        "delivered": 99,
        "opened": 50,
        "clicked": 11,
        "openRate": 50.51,
        "clickRate": 11.11
      }
    }
  ],
  "significance": {
    "metric": "open_rate",
    "status": "not_significant",
    "confidenceLevel": 0.95,
    "leaderVariantId": "var_b",
    "leaderVariantLabel": "B",
    "confidence": 0.7457,
    "pValue": 0.2543,
    "relativeLift": 0.1905
  }
}

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

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

{
  "success": false,
  "error": "A/B test not found"
}

​Request

​Response fields

​Responses

Request

Response fields

Responses