Dynamo Developer DocsDynamo Developer Docs
External APIBroadcasts

Get broadcast details + insights

One broadcast's config plus per-execution delivery insights and a lifetime rollup. `isMM` is **required** and must match the record's family (a mismatch is reported as 404). Maximize-reach MASTER executions are excluded. Up to 50 executions are returned (`executionsReturned`); `executionsTotal` reports the true count.

GET/broadcasts/{broadcastId}

Authorization

x-api-key x-date x-signature
x-api-key<token>

Your API key (the ApiKeys document id).

In: header

x-date<token>

Current timestamp in ISO-8601 (must be fresh — within −5s..+60s of server time).

In: header

x-signature<token>

HMAC-SHA256 of the x-date string keyed by your secret, lowercase hex.

In: header

Path Parameters

broadcastId*string

The broadcast id.

Query Parameters

isMM*string

Must match the record's family.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/broadcasts/string?isMM=true"
{  "id": "string",  "name": "string",  "type": "SINGLE",  "target": "string",  "active": true,  "isMM": true,  "workspaceId": "string",  "mediumId": "string",  "mediumName": "string",  "scheduled": true,  "scheduledFor": "string",  "frequency": "string",  "lastSentAt": "string",  "nextSendAt": "string",  "lastExecutionId": "string",  "metaMessageCampaignName": "string",  "createdAt": "string",  "note": "string",  "lifetime": {    "executions": 0,    "total": 0,    "reachable": 0,    "reached": 0,    "opened": 0,    "clicked": 0,    "reachedRate": 0,    "openRate": 0,    "clickRate": 0  },  "executionsTotal": 0,  "executionsReturned": 0,  "executions": [    {      "executionId": "string",      "sentAt": "string",      "finalized": true,      "progress": 0,      "total": 0,      "reachable": 0,      "reached": 0,      "opened": 0,      "clicked": 0,      "reachedRate": 0,      "openRate": 0,      "clickRate": 0    }  ]}
{  "message": "string"}
{  "message": "string"}
{  "message": "string"}
{  "error": [    {      "message": "string",      "path": [        "string"      ],      "type": "string",      "context": {}    }  ]}

AI conversation-label overview

Per-day (or per-week) counts of AI conversation labels across one VIP workspace's conversations on one channel. The date axis is when the labeled user message was sent; `count` is labeled user messages, `uniqueConversations` is distinct conversations. An `activity` baseline (all user messages) lets label counts be read as rates. Buckets are UTC; the window is capped at 31 days. `workspaceId`, `mediumId`, `from`, and `to` are all **required**.

List broadcasts / marketing messages

List a workspace's broadcasts (metadata only — insight numbers live on the details endpoint). `isMM` selects the family and is **required**: `false` = organic re-engagement broadcasts, `true` = Meta (paid) marketing messages. Optional `type` and `includeArchived` filters; newest first. `workspaceId` is **required**.