Skip to main content
Changes that affect integrations are recorded here. Additive changes — new endpoints, new optional parameters, new response fields — are listed but are not breaking; see Versioning for what that guarantee covers.
v1
React Native and Flutter now expose setDynamicLinkHosts, matching the native host allowlist. getDynamicLink() stays the startup deferred check (and, on Android, the current intent). handleUniversalLink(url) is the live tap: subscribe to React Native Linking, or forward the Flutter app-links stream.Unity and Unreal plugins call the Android and iOS SDKs on mobile exports only. Editor, desktop, and console builds return no link. Guides: React Native, Flutter, Unity, Unreal.
v1
GET /{back_half}?format=json now requires X-API-Key (or X-Dashlink-SDK-Key) with a Dynamic Link key (dlk_sdk_…) bound to the shortlink’s organization. REST keys (dlk_live_) are rejected on the edge; Dynamic Link keys are rejected on /api/v1/*. Missing, revoked, expired, or cross-org keys return 401 and do not publish app_open / deferred_open. Replay of the same click_id does not publish a second deferred_open. Browser 302s stay public.Create the key in Settings → API Keys → Type Dynamic Link, then call Dashlink.configure / DynamicLinks.configure before any SDK resolve. See API keys and Receive.
v1
JSON resolve (GET /{back_half}?format=json) now returns click_id, is_deferred, match_type, and UTM fields, and accepts deferred, match, sdk, sdk_version, and first_open. Outcomes include deferred_open and deferred_miss, joined to the store tap by click_id.Native SDKs (optional for routing, required for deferred) live in their own repos: dashlink-android, dashlink-ios. Dual-mode behaviour is documented in Receive.
v1

v1 is available

The first release of the Dashlink API. Eighty operations across links, QR codes, app dynamic links, campaigns, analytics, branded links, tags, UTM templates, users and account limits, covered by a generated OpenAPI spec and a full reference.

What it does

  • Links — create, update, search and bulk-manage Shortlinks, with custom back halves, password protection, expiry and per-audience routing rules
  • QR codes — generate styled codes backed by trackable Shortlinks, with a centre logo, frame and caption
  • App dynamic links — open your native app when it is installed, fall back to the web when it is not, with the app association files served for you
  • Branded links — serve links from a domain you own or a subdomain Dashlink hosts
  • Campaigns and analytics — group links, break traffic down by dimension, and export reports

Conventions

  • Every endpoint returns {"data": ...} on success and {"error": {...}} on failure, with a stable code on every error
  • Writes are form-encoded; the endpoints that carry an image take multipart/form-data
  • Deleting links and QR codes is bulk-only — pass a one-element array to delete one
  • Analytics responses carry a retention object when your plan’s window shortened the range you asked for

Documentation

  • A generated OpenAPI 3.1 spec with an interactive playground on every operation
  • Guides covering links, QR codes, app dynamic links, branded links, campaigns, analytics and integration patterns
  • An llms.txt index, and a .md variant of every page for use as model context