curl --request GET \
--url https://{notifuseDomain}/api/broadcasts.get \
--header 'Authorization: Bearer <token>'{
"broadcast": {
"id": "broadcast_12345",
"workspace_id": "ws_1234567890",
"name": "Spring Newsletter 2024",
"channel_type": "email",
"status": "draft",
"audience": {
"list": "newsletter",
"segments": [
"premium_users"
],
"exclude_unsubscribed": true
},
"schedule": {
"is_scheduled": true,
"scheduled_date": "2024-03-15",
"scheduled_time": "10:30",
"timezone": "America/New_York",
"use_recipient_timezone": false
},
"test_settings": {
"enabled": true,
"sample_percentage": 20,
"auto_send_winner": true,
"auto_send_winner_metric": "open_rate",
"test_duration_hours": 24,
"variations": [
{
"template_id": "template_variant_a",
"variation_name": "Variation A",
"metrics": {
"recipients": 123,
"delivered": 123,
"opens": 123,
"clicks": 123,
"bounced": 123,
"complained": 123,
"unsubscribed": 123
},
"template": {}
}
]
},
"utm_parameters": {
"source": "newsletter",
"medium": "email",
"campaign": "spring_2024",
"term": "<string>",
"content": "<string>"
},
"metadata": {},
"winning_template": "template_winner",
"test_sent_at": "2023-11-07T05:31:56Z",
"winner_sent_at": "2023-11-07T05:31:56Z",
"test_phase_recipient_count": 123,
"winner_phase_recipient_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"cancelled_at": "2023-11-07T05:31:56Z",
"paused_at": "2023-11-07T05:31:56Z",
"pause_reason": "<string>"
}
}Retrieves a single broadcast by ID. Optionally includes template details for each variation.
curl --request GET \
--url https://{notifuseDomain}/api/broadcasts.get \
--header 'Authorization: Bearer <token>'{
"broadcast": {
"id": "broadcast_12345",
"workspace_id": "ws_1234567890",
"name": "Spring Newsletter 2024",
"channel_type": "email",
"status": "draft",
"audience": {
"list": "newsletter",
"segments": [
"premium_users"
],
"exclude_unsubscribed": true
},
"schedule": {
"is_scheduled": true,
"scheduled_date": "2024-03-15",
"scheduled_time": "10:30",
"timezone": "America/New_York",
"use_recipient_timezone": false
},
"test_settings": {
"enabled": true,
"sample_percentage": 20,
"auto_send_winner": true,
"auto_send_winner_metric": "open_rate",
"test_duration_hours": 24,
"variations": [
{
"template_id": "template_variant_a",
"variation_name": "Variation A",
"metrics": {
"recipients": 123,
"delivered": 123,
"opens": 123,
"clicks": 123,
"bounced": 123,
"complained": 123,
"unsubscribed": 123
},
"template": {}
}
]
},
"utm_parameters": {
"source": "newsletter",
"medium": "email",
"campaign": "spring_2024",
"term": "<string>",
"content": "<string>"
},
"metadata": {},
"winning_template": "template_winner",
"test_sent_at": "2023-11-07T05:31:56Z",
"winner_sent_at": "2023-11-07T05:31:56Z",
"test_phase_recipient_count": 123,
"winner_phase_recipient_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"cancelled_at": "2023-11-07T05:31:56Z",
"paused_at": "2023-11-07T05:31:56Z",
"pause_reason": "<string>"
}
}API token for authentication
The ID of the workspace
The ID of the broadcast
Include full template details for each variation
Broadcast retrieved successfully
Show child attributes
Unique identifier for the broadcast
"broadcast_12345"
The ID of the workspace
"ws_1234567890"
Name of the broadcast
255"Spring Newsletter 2024"
Communication channel type
"email"
Current status of the broadcast
draft, scheduled, sending, paused, sent, cancelled, failed, testing, test_completed, winner_selected "draft"
Show child attributes
Whether the broadcast is scheduled
true
Scheduled date in YYYY-MM-DD format
"2024-03-15"
Scheduled time in HH:MM format
"10:30"
IANA timezone
"America/New_York"
Send at scheduled time in each recipient's timezone
false
Show child attributes
Whether A/B testing is enabled
true
Percentage of audience to use for testing
1 <= x <= 10020
Automatically send winning variation to remaining audience
true
Metric used to determine the winner
open_rate, click_rate "open_rate"
Duration of the test in hours (max 7 days)
1 <= x <= 16824
Test variations (2-8 variations allowed)
2 - 8 elementsShow child attributes
Template ID for this variation
"template_variant_a"
Name of this variation
"Variation A"
Show child attributes
Number of recipients
Number of delivered messages
Number of opens
Number of clicks
Number of bounces
Number of complaints
Number of unsubscribes
Full template object (populated when with_templates=true)
Show child attributes
UTM source parameter
"newsletter"
UTM medium parameter
"email"
UTM campaign parameter
"spring_2024"
UTM term parameter
UTM content parameter
Custom metadata for the broadcast
ID of the winning template variation
"template_winner"
When the A/B test was sent
When the winning variation was sent
Number of recipients in test phase
Number of recipients in winner phase
When the broadcast was created
When the broadcast was last updated
When the broadcast started sending
When the broadcast completed sending
When the broadcast was cancelled
When the broadcast was paused
Reason for pausing the broadcast