Dynamo Developer DocsDynamo Developer Docs
External APIVIPMessages overview

AI conversation-label overview

Per-day (or per-week) counts of AI conversation labels for one VIP workspace's conversations on one channel. An `activity` baseline (all user messages) lets label counts be read as rates. UTC buckets; window capped at 31 days.

get/label-overview

Beta

The External API is in beta. Endpoints, parameters, and response shapes may change — including breaking changes — in future releases. Pin to documented behavior before relying on it in production.

Authorization

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

Your API key (the ApiKeys document id).

In: header

x-date<token>

Current timestamp as an IMF-fixdate string (GMT, US locale) "EEE, dd MMM yyyy HH:mm:ss z", e.g. "Sun, 06 Dec 2020 12:59:11 GMT". 30-second TTL.

In: header

x-signature<token>

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

In: header

x-api-version<token>

API version you're coding against — currently 1. Required; a missing or unsupported value returns 400 with Missing or unsupported x-api-version header. Supported versions: 1.

In: header

Query Parameters

workspaceId*string

The VIP workspace id (from GET /workspaces).

mediumId*string

The channel id (from GET /channels).

startDate*string

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

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

Try it

read-only

Kept in this tab only and signed in your browser — your secret never leaves your device.

Query

Enter your key and secret to send.

curl -X GET "https://example.com/label-overview?workspaceId=AbC123XyZ&mediumId=FB_PAGE_123456789012345&startDate=2026-06-01&endDate=2026-06-30"
{  "workspaceId": "string",  "mediumId": "string",  "groupBy": "day",  "startDate": "2019-08-24T14:15:22Z",  "endDate": "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": {}    }  ]}

Export VIP user messages to CSV

Export all VIP user messages in a window to a CSV and return `{ totalCount, csvUrl }`. Same filters and 31-day cap as the list route, but returns every matching row rather than a capped page.

List Meta ad accounts

The org's connected Meta ad accounts. Returns `400` if the org isn't connected to Meta Ads.