> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dashlink.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# DOCS ASSESSMENT

# Dashlink API Documentation — Completeness & SDK Cross-Check Report

**Date:** 2026-11-19
**Scope:** `dashlink-api-docs` (Mintlify) + all six SDK codebases in `Dashlink SDK/`
**Question asked:** Is the documentation complete and developer-friendly enough that a new developer has a full reference to integrate Dashlink over REST and via the SDKs — and does the SDK code match what the docs describe?

***

## Verdict

**Yes — the documentation is complete, developer-friendly, and accurate to the code.** A new developer onboarding onto Dashlink has what they need to integrate both the REST API and the native SDKs. REST coverage is exact (84/84 endpoints), the foundational concept pages are excellent, and an independent cross-check of all six SDK codebases confirms the documented public API, method signatures, link-object fields, and install coordinates match the real code.

There is a short list of fixable discrepancies. **Two are genuine and should be fixed; the rest are minor polish.**

***

## Part 1 — REST API & guides

### Strengths

* **Complete, verifiably in-sync REST coverage.** 84 endpoints with an exact 1:1 match across three sources: the nav (`docs.json`), the OpenAPI spec (`api-reference/openapi.json`), and the per-group overview tables. Zero missing, zero orphaned. This is enforced by generator scripts (`scripts/generate_nav.py`, `scripts/generate_group_pages.py`) that derive everything from one manifest, with each operation pinning its page URL via `x-mint.href` and `scripts/check_links.py` + `--check` drift detection guarding against rot.
* **Excellent foundational concept pages**, each with working code in six languages (curl/Node/Python/Go/Ruby/PHP):
  * `authentication` — key types (`dlk_live_` vs `dlk_sdk_`), scopes, per-module permissions, the `Authorization: Bearer` gotcha, rotation-by-overlap.
  * `errors` — single envelope, full code table, the critical "bulk calls return 200 even when items fail" semantics, a real retry policy.
  * `rate-limits`, `pagination` (incl. offset-consistency caveat), `versioning` (clear stability contract).
* **Strong quickstart** (create a link → read its analytics, \~5 min).
* **Good ergonomics:** interactive playground, auto-generated 6-language samples, `llms.txt`, changelog, contextual "open in ChatGPT/Claude/Cursor/MCP" options, and a 58-page Help Center for the dashboard side.

### Gaps (REST)

| # | Gap | Severity | Detail |
| - | - | - | - |
| R1 | **Field-level reference is thin** | **Medium (biggest REST gap)** | Only \~27% of request-body fields (75/279) and \~34% of query/path params (162/481) have descriptions, and the spec carries **no request/response examples (0/84)**. Example: `create_shortlink` exposes 26 form fields but documents only a handful (e.g. `destination_payload` undocumented). The playground will show many unexplained fields. |
| R2 | **No official REST client SDK** | Low (set expectations) | "SDKs" means the native *deep-linking* SDKs only; REST integration is raw HTTP. Legitimate, but worth stating so developers don't hunt for a `dashlink-node`/`dashlink-python` package. |
| R3 | **No webhooks/events docs; no idempotency guidance** | Low | If neither exists, say so. The retry guidance doesn't warn that retrying a create after a 500 could duplicate. |

***

## Part 2 — SDK code vs. docs cross-check

Each SDK's actual source was diffed against its guide page (`guides/app-dynamic-links/*.mdx`). **Across all six, the documented public API names, method signatures, all 11 link-object fields, install coordinates, and native-SDK wrapping match the code.** The SDK code is correctly wired and accurately described.

### Per-SDK results

| SDK | Verdict | Notable findings |
| - | - | - |
| **iOS** | Accurate — **1 real doc bug** | Wrong GitHub org in install URLs (see S1). `configure` with a bad key calls `preconditionFailure` (hard crash), which the doc's "rejects" understates. Undocumented public API: `destinationUrl`, `fallbackUrl`, `matchType`, `outcome`, `shortUrl`, `Dashlink` typealias, `DashlinkError`, `sdkVersion`. |
| **Android** | Accurate — minor drift | Exact match on class/methods/install/`minSdk 21`/Play Install Referrer flow. `isDeferred=true`/`clickId` on the deferred return are **server-driven**, not SDK-forced as the doc implies. Undocumented: extra link fields, `navigateToPending` helper, `SDK_VERSION`, a silent 401 retry. |
| **React Native** | Accurate — minor drift | Exact match on package name (`@dashlink/react-native`), methods, fields, `compileOnly`/pod setup, autolinking. Only gap: undocumented `sdkVersion` const and exported `PendingDynamicLink` type. |
| **Flutter** | Accurate — minor drift | Exact match on package (`dashlink ^1.0.0`), methods, fields, pod/gradle. `plugin_platform_interface` dependency is declared but unused (plugin is single-channel, not federated). Undocumented `sdkVersion`. |
| **Unreal** | Accurate — minor drift | Exact name/field matches; `UDashlink` is a Blueprint-exposed function library; off-device empty-link guard verified. `.uplugin` declares no `SupportedTargetPlatforms` (Android/iOS gating is code-side only). |
| **Unity** | Accurate — **1 real mismatch** | Exact match on class/methods/all 11 fields/off-device guard. **iOS error path is wrong (see S2).** Install path under-specified (UPM package `ai.dashlink.unity` exists but doc doesn't name it). Undocumented + partly-dead C# events (`LinkReceived` fires iOS-only; `LinkFailed` is never invoked — dead code). |

### Discrepancies to fix

| # | Issue | Severity | Where |
| - | - | - | - |
| **S1** | **iOS docs point at the wrong GitHub org.** SPM URL, `Package.swift` line, `pod` homepage, and the sample/changelog links all use `github.com/dashlink/dashlink-ios`, but the real remote is `github.com/Dashlink-ai/dashlink-ios`. The SPM URL would not resolve. The podspec's own `source`/`homepage` share the same wrong org. | **High** (breaks first install step) | `guides/app-dynamic-links/ios.mdx`; also `Dashlink.podspec` in the iOS repo |
| **S2** | **Unity: `OnDynamicLinkError` is never called on iOS.** Docs/README say failures arrive on `OnDynamicLinkError`; this is true only on Android. On iOS an error surfaces as an **empty `OnDynamicLink`** success callback. (This is a code bug as much as a doc bug.) | **Medium-High** | `guides/app-dynamic-links/unity.mdx` + `Runtime/Dashlink.cs` / `Plugins/iOS/DashlinkUnityBridge.mm` |
| S3 | **Unity install path under-specified** — no UPM package name (`ai.dashlink.unity`), git URL, OpenUPM scope, or `.unitypackage` given; only "copy it or add it as a package." | Medium | `guides/app-dynamic-links/unity.mdx` |
| S4 | **iOS "rejects" understates "crashes the app"** (`preconditionFailure` on a non-`dlk_sdk_` key). | Low-Medium | `guides/app-dynamic-links/ios.mdx` |
| S5 | **Wrapper-layer vs native-core claims.** Each wrapper page states `dlk_live_` rejection, empty-host-allowlist semantics, and analytics events (`deferred_open`, `app_open`, etc.) as if the wrapper does them. Only the iOS & Android cores enforce the `dlk_sdk_` prefix; the four wrappers pass the key through, and analytics/dedup live in the native core + backend. Not contradictions — but a one-line "handled by the underlying SDK" would prevent confusion. | Low | All wrapper pages (RN, Flutter, Unity, Unreal) |
| S6 | **Undocumented `sdkVersion` const on every SDK**, and under-documented link fields (`destinationUrl`, `fallbackUrl`, `matchType`, `outcome`, `shortUrl`) on several. | Low | All SDK guide pages |

> **Note on S2 (Unity):** this is the one place the docs describe behavior the code does not deliver. The fix is primarily in the Unity SDK (send `OnDynamicLinkError` on the iOS failure path, and either wire up or remove the dead `LinkFailed`/`LinkReceived` C# events), after which the doc is already correct.

***

## Recommended next steps (priority order)

1. **Fix S1 (iOS GitHub org)** — one-line-per-occurrence doc edit; also correct the iOS repo's podspec. Highest impact, lowest effort.
2. **Fix S2 (Unity iOS error path)** — code fix in the Unity SDK; confirm the doc afterward.
3. **Fill the REST field-level reference (R1)** — add descriptions + examples to the OpenAPI spec's request fields and query params. This is the single change that most raises day-to-day developer-friendliness.
4. **Add S3/S4/S5/S6 polish** — Unity install specifics, soften iOS "rejects" wording, add "handled by the underlying SDK" notes to wrapper pages, document `sdkVersion` and the full link-field set.

### Later plan (separate effort)

* **Publish and list each SDK on its respective package manager.** Alongside correcting the repo references (S1), the SDKs should be published to — and documented with — their standard registries, so developers install via the idiomatic tool for each platform rather than a raw git URL:

  | SDK | Package manager(s) to list |
  | - | - |
  | iOS | CocoaPods + Swift Package Manager |
  | Android | Maven Central (Gradle) |
  | React Native | npm |
  | Flutter | pub.dev |
  | Unity | OpenUPM / UPM (git or scoped registry) |
  | Unreal | Fab / marketplace (or versioned git release) |

  Tracked as a **separate follow-up plan** — the install sections of each SDK guide update once the packages are actually published.

***

## How this was assessed

* REST: endpoint/nav/spec cross-count, per-operation schema/description/example coverage, `x-mint.href` link-integrity verification, and a read of the quickstart + all five concept pages + representative guides.
* SDKs: six parallel code reviews, one per SDK, each diffing the public API surface, install coordinates, version, and link-object fields against the corresponding guide page with file:line evidence.

*All review was read-only; no code or docs were modified.*


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.