API reference

Redirects to the destination URL associated with :code. Records a click with device, browser, OS, country, and referrer metadata.

Returns all short links, optionally filtered by project.

[
  {
    "id":          1,
    "code":        "abc123",
    "url":         "https://example.com/very/long/url",
    "title":       "Example page",
    "project_id":  2,          // null if not in a project
    "project_name": "Marketing",
    "project_color":"#6366f1",
    "clicks":       42,
    "created_at":   "2025-01-01 12:00:00"
  }
]

{ "id": 7, "code": "x9kp2" }

Update any fields of an existing link. All fields are optional — only provided fields are changed.

{ "ok": true }

Permanently deletes the link and all associated click history.

{ "ok": true }

[
  {
    "id":         1,
    "name":       "Marketing",
    "color":      "#6366f1",
    "link_count": 12,
    "created_at": "2025-01-01 12:00:00"
  }
]

{ "id": 3 }

{ "ok": true }

Permanently deletes the project. All links in the project and their click history are also deleted.

{ "ok": true }

Returns click analytics for a single link, broken down by time period, country, device, browser, OS, and referrer.

{
  "code":       "abc123",
  "url":        "https://example.com/...",
  "title":      "Example",
  "total":      142,
  "daily": [
    { "date": "2025-06-01", "count": 14 },
    ...
  ],
  "by_country":  [{ "label": "US", "count": 80 }, ...],
  "by_device":   [{ "label": "mobile", "count": 95 }, ...],
  "by_browser":  [{ "label": "Chrome", "count": 70 }, ...],
  "by_os":       [{ "label": "iOS", "count": 60 }, ...],
  "by_referer":  [{ "label": "twitter.com", "count": 30 }, ...]
}

Returns aggregate statistics used by the dashboard overview tab — totals, top links, daily chart data, and breakdowns.

Downloads all links as a CSV file with columns: code, url, title, project, clicks, created_at.

Returns text/csv with Content-Disposition: attachment; filename="links.csv".

code,url,title,project,clicks,created_at
abc123,https://example.com,Example,Marketing,42,2025-01-01 12:00:00

Accepts a CSV (same format as export) and inserts new links. Rows with duplicate short codes are skipped.

Send the CSV as multipart/form-data with the file field named file, or as raw text/csv body.

{
  "inserted": 15,
  "skipped":  2,   // duplicate codes
  "errors":   0
}