Dynamo Developer DocsDynamo Developer Docs
External APILabel overview

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**.

GET/label-overview

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

Query Parameters

workspaceId*string

The VIP workspace id (from GET /workspaces).

mediumId*string

The channel id (from GET /channels).

from*string

Window start — ISO date (e.g. 2026-06-01).

to*string

Window end — ISO date (a date-only value is inclusive of that whole day).

groupBy?string

Bucket granularity (defaults to day).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/label-overview?workspaceId=string&mediumId=string&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z"
{  "workspaceId": "string",  "mediumId": "string",  "groupBy": "day",  "from": "2019-08-24T14:15:22Z",  "to": "2019-08-24T14:15:22Z",  "buckets": {    "property1": {      "property1": {        "count": 0,        "uniqueConversations": 0      },      "property2": {        "count": 0,        "uniqueConversations": 0      }    },    "property2": {      "property1": {        "count": 0,        "uniqueConversations": 0      },      "property2": {        "count": 0,        "uniqueConversations": 0      }    }  },  "totals": {    "property1": {      "count": 0,      "uniqueConversations": 0    },    "property2": {      "count": 0,      "uniqueConversations": 0    }  },  "activity": {    "property1": {      "userMessages": 0,      "activeConversations": 0    },    "property2": {      "userMessages": 0,      "activeConversations": 0    }  },  "activityTotals": {    "userMessages": 0,    "activeConversations": 0  },  "customLabels": {    "property1": {      "name": "string",      "color": "string"    },    "property2": {      "name": "string",      "color": "string"    }  },  "conversationsScanned": 0}
{  "message": "string"}
{  "message": "string"}
{  "message": "string"}
{  "message": "string"}
{  "error": [    {      "message": "string",      "path": [        "string"      ],      "type": "string",      "context": {}    }  ]}

List VIP users

The VIP users (players marked VIP for the workspace) on one channel, with their profile fields and resolved personal-info (including birthday). Rows are highest-LTV first; paginated via `limit` + `offset` with `total` and `nextOffset`. Optional birthday filters: `hasBirthday=true` and `birthdayMonth=1..12`. `workspaceId` and `mediumId` are **required**; the workspace must be a VIP workspace and the channel connected to it.

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.