Links

Resolve a link by slug

Looks up a link by its slug and optional domain. Returns the link's deep link configuration for SDK use. A resolve that returns link data to the WarpLink SDK on a device records one click with the source app_open, so an in-app open appears in analytics and counts toward your plan's click allowance. Nothing else records a click: not a refusal, not a known bot, and not a server script or CI job calling this endpoint with a standard API key, which still receives the link data. destination_url and the platform URLs are normalized exactly the way the redirect path normalizes them, so a bare origin comes back with its trailing slash, and custom_params includes the query parameters already on the stored destination. A resolve that carries the same X-WarpLink-Tap-Id as an earlier one records one click, not two, so a client may safely retry a request whose response it never received. A slug that is the old address of a moved link resolves to the moved link: the response carries the link's current domain and slug, and the old address keeps working for as long as the link exists.

get/links/resolve/{slug}

Request

  • Base URL: https://api.warplink.app/v1
  • URL: https://api.warplink.app/v1/links/resolve/{slug}
  • Auth: HTTP bearer

Path parameters

slugstring required

Query parameters

domainstring

Domain to resolve the slug against. Defaults to aplnk.to.

paramsstring

The tapped URL's raw query string, without the leading question mark. Applied to the returned destination and platform URLs the same way the redirect path applies it.

Headers

X-WarpLink-Tap-Idstring uuid

A UUID identifying one tap. The WarpLink SDKs mint one per tap and send the same value on every bounded retry of that tap, so a request whose response was lost does not record a second click. Used as the click's id when it is a valid UUID; an absent or malformed value is ignored and an id is generated instead.

Response

Resolved link

idstring uuid
slugstring
domainstring
destination_urlstring uri
ios_urlstring uri nullable
ios_fallback_urlstring uri nullable
android_urlstring uri nullable
android_fallback_urlstring uri nullable
custom_paramsobject
created_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.