Create a new deep link in LinkForty. Supports device-specific URLs (iOS App Store, Google Play, web fallback), UTM parameters, targeting rules, custom short codes, deep link parameters, attribution window, and expiration. If no templateId or templateSlug is provided, the workspace default template is used automatically. Returns the created link with its short URL.

List deep links in the current workspace. Supports filtering by status (active/inactive), source (dashboard/sdk/bulk/migration), project, search query (title/description/short code), and date range. Returns a paginated list with click counts.

Get a single deep link by ID or short code. Use this to inspect a specific link's configuration, destinations, UTM parameters, and stats.

Update an existing deep link. All fields are optional — only provided fields are updated. Use this to change destinations, UTM parameters, targeting rules, status (active/inactive), or expiration.

Permanently delete a deep link by ID. This action cannot be undone — historical click events for the link are also removed.

Create up to 100 deep links in a single request. Each link in the array uses the same shape as create_link. If no templateId or templateSlug is provided on a link, the workspace default template is used automatically. Returns the count and the array of created links. Useful for importing campaigns or generating links in bulk.

Get detailed analytics for a single deep link. Returns total clicks, unique clicks, time series, and breakdowns by country, city, region, timezone, device, and platform. Use the days parameter to control the lookback window (default: 30 days).

Get workspace-wide analytics across all links. Returns total clicks, unique clicks, time series, geo breakdown (country/city/region/timezone), device/platform/browser breakdown, hourly distribution, UTM parameter breakdown (source/medium/campaign), referrers, and top performing links. Default lookback is 30 days.

Get the top performing links in the workspace ranked by total clicks. Returns each link's short code, title, total clicks, and unique clicks. Default lookback is 30 days.

Get install attribution data showing how app installs are linked to clicks via device fingerprinting. Pass a linkId to get installs for a specific link, or omit it for workspace-wide stats. Returns total installs, attributed vs organic split, attribution rate, time series, platform breakdown, and recent installs. Note: requires the analytics:installs permission.

Get the conversion funnel from clicks → installs → events for the workspace. Returns total clicks, unique clicks, total/attributed installs, click-to-install conversion rate, average/median/p75/p95 time to install, and the top converting links. Useful for understanding overall campaign efficiency. Note: requires the analytics:installs permission.

List all link templates in the current workspace. Templates define default destinations, UTM parameters, and targeting rules that new links can inherit. Each template has a slug used for URL routing.

Create a new link template. Templates let you define default destinations (iOS/Android/web), UTM parameters, targeting rules, and attribution windows that new links inherit. Useful for ensuring consistency across campaigns.

Mark a template as the default for the workspace. The default template is used by the SDK when creating links from mobile apps without specifying a template.

List all projects in the current workspace. Projects are containers for organizing related deep links — for example, by campaign, product, or feature.

Create a new project to group related links. Returns the created project. Use the project ID when creating links to associate them with this project.

List all workspaces accessible by the current API key. Note: API keys are scoped to a single workspace, so this typically returns one workspace. Use this to confirm which workspace the AI is connected to.

Get details about the current workspace including subscription tier, member count, link count, project count, and settings. Returns the workspace bound to the active API key.

Get the iOS/Android app configuration for the current workspace, including app scheme, bundle IDs, package name, Universal Link/App Link domains, app store URLs, and SHA256 fingerprints. Use this to know how to integrate the SDK or build deep link URLs that open the right app.

Generate a ready-to-paste SDK initialization snippet for a specific mobile platform. The snippet is pre-filled with the user's API key, base URL, and app config (bundle IDs, schemes, link domains) from the current workspace. Supported platforms: react-native, expo, ios, android, flutter. Use this to help a developer integrate LinkForty into their mobile app in under a minute.