Skip to main content
GET
/
api
/
broadcasts.getTestResults
Get A/B test results
curl --request GET \
  --url https://{notifuseDomain}/api/broadcasts.getTestResults \
  --header 'Authorization: Bearer <token>'
{
  "broadcast_id": "broadcast_12345",
  "status": "testing",
  "test_started_at": "2023-11-07T05:31:56Z",
  "test_completed_at": "2023-11-07T05:31:56Z",
  "variation_results": {},
  "recommended_winner": "template_variant_a",
  "winning_template": "template_variant_a",
  "is_auto_send_winner": true
}

Authorizations

​
Authorization
string
header
required

API token for authentication

Query Parameters

​
workspace_id
string
required

The ID of the workspace

​
id
string
required

The ID of the broadcast

Response

Test results retrieved successfully

​
broadcast_id
string

ID of the broadcast

Example:

"broadcast_12345"

​
status
string

Current broadcast status

Example:

"testing"

​
test_started_at
string<date-time> | null

When the test started

​
test_completed_at
string<date-time> | null

When the test completed

​
variation_results
object

Results for each variation, keyed by template_id

​
recommended_winner
string | null

Recommended winning template ID based on metrics

Example:

"template_variant_a"

​
winning_template
string | null

Selected winning template ID

Example:

"template_variant_a"

​
is_auto_send_winner
boolean

Whether winner will be automatically sent

Example:

true