Get an A/B test email campaign results | Brevo API Documentation

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.emailCampaigns.getAbTestCampaignResult(1);
}
main();

{
  "clickRate": "50%",
  "clickedLinks": {
    "Version A": [
      {
        "clickRate": "0%",
        "clicksCount": 0,
        "link": "https://google.com"
      },
      {
        "clickRate": "0%",
        "clicksCount": 0,
        "link": "https://youtube.com"
      }
    ],
    "Version B": [
      {
        "clickRate": "40%",
        "clicksCount": 2,
        "link": "http://www.github.com"
      },
      {
        "clickRate": "60%",
        "clicksCount": 3,
        "link": "http://www.stackoverflow.com"
      }
    ]
  },
  "openRate": "100%",
  "statistics": {
    "clicks": {
      "Version A": "0%",
      "Version B": "50%"
    },
    "complaints": {
      "Version A": "0%",
      "Version B": "0%"
    },
    "hardBounces": {
      "Version A": "0%",
      "Version B": "0%"
    },
    "openers": {
      "Version A": "20%",
      "Version B": "100%"
    },
    "softBounces": {
      "Version A": "0%",
      "Version B": "0%"
    },
    "unsubscribed": {
      "Version A": "20%",
      "Version B": "0%"
    }
  },
  "winningCriteria": "Click",
  "winningVersion": "B",
  "winningVersionRate": "0%"
}

Obtain winning version of an A/B test email campaign

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Path parameters

campaignIdlongRequired

Id of the A/B test campaign

Response

A/B test email campaign Result

clickRatestring

Click rate for current winning version

clickedLinksobject

openRatestring

Open rate for current winning version

statisticsobject

winningCriteriaenum

Criteria chosen for winning version (Open/Click)

Allowed values:

winningSubjectLinestring

Subject Line of current winning version

winningVersionenum

Winning Campaign Info. pending = Campaign has been picked for sending and winning version is yet to be decided, tie = A tie happened between both the versions, notAvailable = Campaign has not yet been picked for sending.

Allowed values:

winningVersionRatestring

Open/Click rate for the winner version

Errors

400

Bad Request Error

404

Not Found Error