Skip to main content
GET
/
api
/
v1
/
public
/
broadcasts
/
{id}
Get broadcast status + stats
curl --request GET \
  --url http://localhost:3001/api/v1/public/broadcasts/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "NotStarted",
  "scheduledAt": "<string>",
  "startedAt": "<string>",
  "completedAt": "<string>",
  "stats": {
    "queued": 4503599627370495,
    "sent": 4503599627370495,
    "failed": 4503599627370495
  }
}

Documentation Index

Fetch the complete documentation index at: https://segmentflow.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Default Response

​
id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
​
name
string
required
​
status
enum<string>
required

Lifecycle status of a broadcast campaign

Available options:
NotStarted,
InProgress,
Triggered,
Sent,
Failed,
Archived,
Warming,
Paused
​
scheduledAt
string | null
required
​
startedAt
string | null
required
​
completedAt
string | null
required
​
stats
object
required