Dynamo Developer DocsDynamo Developer Docs
External APISuperlinks

List superlinks

The org's superlinks, newest first — **active links only**; links minted as part of an in-app links group are excluded (they're managed via their group in-app). Optional `workspaceId` narrows to one workspace. Cursor-paginated. The org-wide (no `workspaceId`) page is filtered server-side **after** the page is read, so a page may return fewer than `limit` items while `mayHaveMore` is `true` — keep paging with `nextCursor` until `mayHaveMore` is `false`.

get/superlinks

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

Only that workspace's superlinks (from GET /workspaces).

limit?integer

Max superlinks per page.

after?string

Opaque page cursor — a previous response's nextCursor.

Response Body

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/superlinks?workspaceId=AbC123XyZ"
{  "items": [    {      "id": "abc12",      "name": "Summer Sale",      "active": true,      "superlink": "https://l.dynamo.fyi/brand/abc12",      "redirectLink": "https://store.example.com/summer",      "redirectLinkName": "Store — summer landing",      "workspaceId": "ws_123",      "created": "2026-08-20T09:00:00.000Z",      "createdTimestamp": 1787475600000    }  ],  "returned": 0,  "mayHaveMore": true,  "nextCursor": "string"}
{  "message": "string"}
{  "message": "string"}
{  "message": "string"}
{  "error": [    {      "message": "string",      "path": [        "string"      ],      "type": "string",      "context": {}    }  ]}

Get (a single) marketing message insights

One marketing message's metadata **plus** per-send delivery insights and a lifetime rollup. Each `executions` entry is one logical send; up to 50 are returned (`executionsReturned`), with `executionsTotal` giving the true count. Also carries the message creative: `messages` is the **current** creative (one entry per variant); each send reports `notificationIndex` — the variant it used — plus `sentMessage`, the creative **exactly as that send went out** (compare it with `messages` to spot later edits) with per-button `clicks` folded in wherever the button sits (top-level, carousel card, or follow-up). Optional `startDate` / `endDate` (both together) window the **returned executions** by send date — without a window, a recurring message returns its newest sends up to the cap, which can miss a historical range entirely. `lifetime` and `executionsTotal` always cover **all** sends; a windowed response adds `window` and `executionsInWindow` so you can detect a truncated window.

Get a superlink with its click count

One superlink plus its lifetime `totalClickCount` — computed from analytics at call time (the same number the in-app insights dialog shows), which makes this noticeably slower than the list. Fetch the list to browse, this for numbers.