US
URL ShortenerDocs & Guide
Dashboard

Documentation & User Guide

Everything you need to know about creating fast short links, securing URLs with passcodes, generating instant QR codes, and tracking real-time analytics.

Getting Started

URL Shortener allows you to convert long, unwieldy web addresses into clean, memorable links in seconds. You can use it as a guest or sign in for complete management capabilities.

1. Instant Shortening

Paste your destination URL on the homepage and click Shorten URL ➔. Your link and QR code are ready immediately.

2. Sign In for Dashboard

Authenticate with Google to customize aliases, view 7-day click analytics, lock URLs with passcodes, and manage all your links in one place.

Custom Aliases & Branded Slugs

Instead of random 7-character strings (e.g. /wIsLm0z), you can create branded aliases that match your campaigns (e.g. /summer-sale).

Rules for Custom Aliases

  • Length must be between 3 and 20 characters.
  • Allowed characters: Letters (a-z, A-Z), numbers (0-9), dashes (-), and underscores (_).
  • Must be unique and not already taken by another link.

Passcode Protection

Need to share sensitive files, beta previews, or private dashboards? You can lock any short URL with an optional password.

How Passcode Protection Works

When someone clicks a protected short URL, they are not redirected immediately. Instead, they are presented with the secure /unlock/[code] screen asking for the passcode. Once the correct password is entered, they are seamlessly forwarded to the destination.

Instant QR Code Generation

Every shortened URL automatically generates a high-contrast QR code optimized for digital displays, printed flyers, business cards, and presentations.

One-Click Download

Download high-resolution PNG image assets directly from the homepage card or the dashboard QR modal.

Mobile Scanning

Compatible with standard iOS Camera, Android Google Lens, and all barcode reader apps.

Real-Time Analytics & Engagement

Gain valuable insights into where and how your audience is engaging with your links.

Geo & Referral Sources

Tracks visitor country codes via CDN headers & IP resolution, alongside traffic sources (Google, X / Twitter, LinkedIn, GitHub, Direct).

Device & OS Breakdown

Categorizes visitors by device type (Desktop, Mobile, Tablet) and operating system (iOS, Android, Windows, macOS, Linux).

REST API Reference

Programmatically create short links and verify passwords via JSON HTTP APIs.

Language:
POST/api/shorten

Shortens a destination URL and returns the short link metadata and code.

const res = await fetch("https://your-domain.com/api/shorten", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    url: "https://example.com/very-long-landing-page",
    pass: "secret123" // Optional passcode protection
  })
});

const data = await res.json();
console.log("Short URL:", data.shortUrl);
// Output: { id: "...", shortCode: "k9xL2pQ", shortUrl: "https://your-domain.com/k9xL2pQ" }
POST/api/verify-password

Verifies access passcode for a locked URL and returns original destination on success.

const res = await fetch("https://your-domain.com/api/verify-password", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    code: "k9xL2pQ",
    password: "secret123"
  })
});

const data = await res.json();
if (res.ok) {
  window.location.href = data.url; // Destination URL
}

Frequently Asked Questions

How fast is link redirection?

Links are cached in an in-memory Redis layer with 1-hour TTL, enabling ultra-fast sub-millisecond 302 redirects with non-blocking click tracking.

Do short links expire automatically?

By default, links do not expire unless you specify an optional expiration date during link creation.

Is analytics tracking privacy-friendly?

Yes. We do not store raw IP addresses or personal identifying info—only aggregated metrics such as country code, device category, OS, and referrer source.