API Docs
Server API

Server APIs

Use Server APIs from trusted backend services to manage links, publish customer events, and read analytics with the Server API Key.

Server API Key

Use the api-key header for workspace-owned resources.

Short-link and deep-link creation and management, domains, server events, link analytics, and raw-event export use this key.

Server Event Quickstart

Publish product events from your backend. Every event must identify an active workspace link using linkId, clickId, or attributionId.

Publish an event
curl -X POST "https://api.shortify.com/v1/events" \
  -H "api-key: sk_live_your_server_key" \
  -H "Content-Type: application/json" \
  --data '{
    "events": [{
      "name": "purchase",
      "eventId": "order-1001",
      "linkId": "link_01HV5A4W7QJ9K2X4Q8ZW5FGZ2R",
      "properties": {"currency": "USD", "value": 49}
    }]
  }'

Server API Reference

Secret-key APIs for short-link and deep-link management, read-only domains, customer events, and analytics.

LinksOpen

Create, list, retrieve, update, and archive standard short links.

GET
/v1/links

List standard short links with search, filtering, sorting, and cursor pagination.

POST
/v1/links

Create a short link with JSON fields for destination, domain, tags, tracking, and metadata.

GET
/v1/links/{linkId}

Retrieve a link by stable resource ID. PATCH updates it, and DELETE archives it.

Deep LinksOpen

Create and manage app-bound deep links using a Server API Key.

GET
/v1/deep-links

List deep links owned by the workspace with the same filters as standard links.

POST
/v1/deep-links

Create a deep link for a workspace-owned app with destination, metadata, tracking, expiration, and routing options.

GET
/v1/deep-links/{linkId}

Retrieve, update, or archive a deep link by stable resource ID.

DomainsOpen

Read verified and archived domain inventory. Domain setup stays in the web panel.

GET
/v1/domains

List domains with search, exact-domain filtering, archived filtering, sorting, and cursor pagination.

GET
/v1/domains/{domainId}

Retrieve a single domain by ID.

Events & AnalyticsOpen

Publish customer events and read link, app, and raw-event analytics.

POST
/v1/events

Publish link-bound customer events from a trusted backend.

GET
/v1/analytics/links/{linkId}

Return summary, time series, breakdowns, recent events, and LaunchView metrics for one link.

GET
/v1/analytics/deep-link-apps/{appId}

Return app-level analytics for a workspace-owned deep-link app ID.

GET
/v1/analytics/events

Export click, LaunchView, install, first-open, and customer-event rows with cursor pagination.