Get a broadcast
curl --request GET \
--url https://api.subscriber.dev/workflows/{workflowId}/broadcasts/{broadcastId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.subscriber.dev/workflows/{workflowId}/broadcasts/{broadcastId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.subscriber.dev/workflows/{workflowId}/broadcasts/{broadcastId}', 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.subscriber.dev/workflows/{workflowId}/broadcasts/{broadcastId}",
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.subscriber.dev/workflows/{workflowId}/broadcasts/{broadcastId}"
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))
}HttpResponse<String> response = Unirest.get("https://api.subscriber.dev/workflows/{workflowId}/broadcasts/{broadcastId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.subscriber.dev/workflows/{workflowId}/broadcasts/{broadcastId}")
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{
"publicId": "<string>",
"status": "pending",
"matchedCount": 123,
"sendOverHours": 123,
"createdAt": "2023-11-07T05:31:56Z",
"sentCount": 123,
"failedCount": 123,
"skippedCount": 123,
"pendingCount": 123,
"bouncedCount": 123,
"hardBounceCount": 123,
"softBounceCount": 123,
"successRate": 123
}{
"statusCode": 404,
"message": "Workflow not found",
"error": "Not Found",
"errors": [
{
"path": [
"<string>"
],
"message": "<string>",
"code": "<string>"
}
]
}{
"statusCode": 404,
"message": "Workflow not found",
"error": "Not Found",
"errors": [
{
"path": [
"<string>"
],
"message": "<string>",
"code": "<string>"
}
]
}{
"statusCode": 404,
"message": "Workflow not found",
"error": "Not Found",
"errors": [
{
"path": [
"<string>"
],
"message": "<string>",
"code": "<string>"
}
]
}Broadcasts
Get a broadcast
Returns a single broadcast with its resolved audience size and derived step-outcome counts (sent/failed/skipped/pending)
GET
/
workflows
/
{workflowId}
/
broadcasts
/
{broadcastId}
Get a broadcast
curl --request GET \
--url https://api.subscriber.dev/workflows/{workflowId}/broadcasts/{broadcastId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.subscriber.dev/workflows/{workflowId}/broadcasts/{broadcastId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.subscriber.dev/workflows/{workflowId}/broadcasts/{broadcastId}', 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.subscriber.dev/workflows/{workflowId}/broadcasts/{broadcastId}",
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.subscriber.dev/workflows/{workflowId}/broadcasts/{broadcastId}"
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))
}HttpResponse<String> response = Unirest.get("https://api.subscriber.dev/workflows/{workflowId}/broadcasts/{broadcastId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.subscriber.dev/workflows/{workflowId}/broadcasts/{broadcastId}")
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{
"publicId": "<string>",
"status": "pending",
"matchedCount": 123,
"sendOverHours": 123,
"createdAt": "2023-11-07T05:31:56Z",
"sentCount": 123,
"failedCount": 123,
"skippedCount": 123,
"pendingCount": 123,
"bouncedCount": 123,
"hardBounceCount": 123,
"softBounceCount": 123,
"successRate": 123
}{
"statusCode": 404,
"message": "Workflow not found",
"error": "Not Found",
"errors": [
{
"path": [
"<string>"
],
"message": "<string>",
"code": "<string>"
}
]
}{
"statusCode": 404,
"message": "Workflow not found",
"error": "Not Found",
"errors": [
{
"path": [
"<string>"
],
"message": "<string>",
"code": "<string>"
}
]
}{
"statusCode": 404,
"message": "Workflow not found",
"error": "Not Found",
"errors": [
{
"path": [
"<string>"
],
"message": "<string>",
"code": "<string>"
}
]
}Authorizations
bearerapi-key
A session token from subscriber login, used by subscriber.dev's own apps. Requests about an environment also need its ID in the x-environment-id header. From your own code, use an API key.
Response
completed: every matched subscriber has a run and no sends are pending.
Available options:
pending, queued, failed, paused, cancelled, completed Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$