Broadcasts

Get A/B test results

GET https://demo.notifuse.com/api/broadcasts.getTestResults

Retrieves the performance metrics for all variations in an A/B test broadcast.

Authorizations

Authorization string header required

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Query Parameters

workspace_id string required

The ID of the workspace

  • Example: ws_1234567890
id string required

The ID of the broadcast

  • Example: broadcast_12345

Response

200 Test results retrieved successfully object
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 map<string, object>

Results for each variation, keyed by template_id

Show child attributes
template_id string

Template ID for this variation

  • Example: template_variant_a
template_name string

Template name

  • Example: Variation A
recipients integer

Total sent emails

  • Example: 1000
delivered integer

Total delivered emails

  • Example: 980
opens integer

Number of opens

  • Example: 450
clicks integer

Number of clicks

  • Example: 120
opens_tracked integer

Sent emails of this variation that carried the open pixel

  • Example: 1000
clicks_tracked integer

Sent emails of this variation whose links were tracked

  • Example: 1000
open_rate number<float>

Open rate (opens / opens_tracked); 0 when no email was tracked

  • Example: 0.45
click_rate number<float>

Click rate (clicks / clicks_tracked); 0 when no email was tracked

  • Example: 0.12
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
400 Bad request - validation failed object
error string required

Error message

401 Unauthorized - invalid or missing authentication token object
error string required

Error message

500 Internal server error object
error string required

Error message