Documentation

Set up, route, embed, and integrate.

Step-by-step guides for your first project. Reference docs for the REST API, routing rules, and workspace security.

Start here

Get your first link live

Create a workspace, add a project, and publish a branded /go/ link. Offers are optional — a link only needs a project and a destination URL.

  1. 01

    Create a workspace

    Name it and set your default timezone.

  2. 02

    Add a project

    The project holds your offers and links.

  3. 03

    Publish a /go/ link

    Set a destination, open the link to test the redirect, then check the click in analytics.

Guides

How-to guides

Getting started

Guide · New users

Workspace → project → offer (optional) → /go/ link → test the redirect → watch the first click land.

  • Create a workspace and project
  • Add an offer, then a /go/ link
  • Test the redirect and check link health

Projects & links

Guide · All users

The data model is Workspace → Project → Offer (optional) → /go/ link → destination, with a fallback URL per link.

  • Slugs and destinations
  • Offer library (optional per link)
  • Fallback URL and link status

Routing rules

Guide · Operators

Rules are evaluated by ascending priority; the first match wins. Country, device, and fallback rules are supported today.

  • Country rules (ISO code match)
  • Device rules (mobile / desktop / tablet)
  • Priority order and fallback

Snippets & embeds

Guide · Developers

Copy-paste code generated per link: React and Next.js components, HTML, a JS loader, product box, Webflow, WordPress, Shopify, email, and social captions.

  • React / Next.js component
  • HTML, JS loader & product box
  • WordPress, Webflow, Shopify, YouTube

Reference

Technical reference

API reference

Reference · Developers

REST endpoints for links and clicks. Keys are scoped to one workspace and rate limited per minute.

  • Bearer tl_live_… authentication
  • Links: list, create, read, update, delete
  • Clicks: list recent clicks

Health & alerts

Reference · All users

Destinations are probed on a schedule. Broken links are flagged in the dashboard and raise an alert you can resolve.

  • Health checks and status codes
  • Broken-link alerts
  • Fix destination flow

Roles & security

Reference · Admins

Owner, admin, editor and viewer roles, row-level workspace isolation, TOTP two-factor, session revocation, and an exportable audit log.

  • Roles & permissions
  • Two-factor (TOTP) & sessions
  • Audit log export

API

REST API reference

Available now: links and clicks. Every request is authenticated with a workspace API key and scoped to that workspace. API access is included on Agency and Enterprise plans.

Authentication

Create a key in Settings → API keys. Keys start with tl_live_, are shown once, and are scoped to a single workspace. Delete a key in the same screen to revoke it, then create a replacement to rotate.

curl https://tracklume.com/api/public/v1/links \
  -H "Authorization: Bearer $TRACKLUME_TOKEN"

Base URL: https://tracklume.com/api/public/v1

Create a link

name, destination_url and project_id are required. Optional: slug, fallback_url, merchant, category, channel_tag, disclosure_label.

curl -X POST https://tracklume.com/api/public/v1/links \
  -H "Authorization: Bearer $TRACKLUME_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Hosting deal",
       "destination_url":"https://example.com/offer",
       "project_id":"<project-uuid>"}'

Returns 201 with { "data": { … } }. Example response fields: id, name, slug, destination_url, fallback_url, status, project_id, created_at.

MethodPathDescriptionParameters
GET/v1/linksList links in the workspace, newest first.limit (max 200), project_id
POST/v1/linksCreate a link in a project you own.JSON body
GET/v1/links/:idFetch a single link.
PATCH/v1/links/:idUpdate editable link fields.JSON body
DELETE/v1/links/:idDelete a link. Returns 204.
GET/v1/clicksList clicks (last 7 days by default).limit (max 500), link_id, since

Errors

Errors return JSON as { "error": "message" }.

  • 400 — invalid JSON, missing required fields, or no editable fields supplied
  • 401 — missing or invalid Bearer key
  • 404 — link or project not found in this workspace
  • 413 — request body larger than 64 KB
  • 429 — rate limit exceeded
  • 500 — unexpected server error

Rate limits

Requests are limited per API key in a rolling one-minute window (default 60 requests/minute). Every response carries the current window state:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1765000000

Over the limit returns 429 with a Retry-After header in seconds.

Can't find what you need?

New guides are added as features ship. Email support for a specific workflow or integration — we reply by email, there is no live chat yet.