Feature docs

Link shortener app on Vareons: install, custom slugs, and tracking

The link shortener app is the id link-shortener marketplace card opening /dashboard/link-shortener: it shortens campaign links with a custom slug, tags, expiry date, and live preview, and every link resolves through a public /s/[slug] route with click statistics.

Last verified: 2026-09-19

The app installs from the /dashboard/apps marketplace with an Install button on the "Link Shortener" card described as shortening and tracking campaign and marketing links, after which an Open button leads to /dashboard/link-shortener. The page has four tabs — Overview, Create Link, Manage Links, and Analytics — with client-side loaded components.

The create form asks for the link name, a custom slug of 3 to 50 characters in letters-numbers-dashes format with an auto-generate button, the full destination URL, a description, tags with an add button, and an optional expiration date. Beside it, a live preview shows the short link as http://{tenantSlug}.{domain}/s/{slug} with a copy button and a QR placeholder that stays pending until the form is complete, plus an information card: name, destination, status (Ready or Incomplete), expiry, and tags.

Pre-submit validation covers the slug format, a new-URL check for the destination, and the user id, then POST /api/dashboard/shortlinks. On a duplicate slug the server returns 409 SLUG_ALREADY_EXISTS with suggested alternatives. After success the form resets and the UI switches automatically to the Manage tab.

The Overview tab shows total links, total clicks, active links, and average clicks with a refresh button, a top-five links list with quick copy, and latest clicks with device icon and country. Statistics derive from GET shortlinks, then activity comes from GET recent-activity capped at five.

Links are stored in the ShortLink model with tenant, per-tenant unique slug, name up to 100 characters, original URL in http(s) format, description, status (active, paused, or archived), expiration date, tags, and analytics for total and unique clicks, last click, and breakdowns by date, device, and country.

Setup steps in Vareons

  1. Install the app from the marketplace

    Open /dashboard/apps, press Install on the link shortener card, then press Open to reach /dashboard/link-shortener.

  2. Create a short link

    From the Create Link tab enter the name, custom slug, destination URL, tags, and expiry, watch the preview until status reads Ready, then press Create.

  3. Copy and share

    Copy the short link from the preview or Manage and share it in your campaigns; opening resolves through /s/[slug].

  4. Manage the links

    From the Manage tab rename or re-describe a link, pause one temporarily, delete it, or reactivate it per campaign.

  5. Track the clicks

    From the Overview and Analytics tabs review totals, active counts, averages, top links, and latest clicks by device and country.

Frequently asked questions

What are the custom slug rules?

From 3 to 50 characters in letters, numbers, dashes, and underscores, unique per tenant; duplicates return a 409 error with alternatives.

How does the short link resolve?

Through a public /s/[slug] route on your store domain that redirects to the original destination and records a click event in analytics.

Can a link expire automatically?

Yes, the expiration date field is optional; past the date, redirection stops and the status shows expired in Manage.

What click statistics are available?

Total and unique counts, last click, and breakdowns by date, device, and country, plus top-five links and the latest five clicks.

Is the preview QR code real?

No, the preview QR element is a placeholder; real codes come from the QR maker app and link to the short URL manually.

Troubleshooting

1) 409 on create: the slug is taken; pick a suggested alternative or generate a new slug. 2) Incomplete status: complete the name, a valid slug, and an http(s) destination URL. 3) Link not redirecting: check its status (paused, archived, or expired) and reactivate. 4) Stats not updating: press refresh; recent activity is fetched capped at five items.

Important limitations

• Slugs cap at 50 characters, names at 100, descriptions at 500, and tags at 30. • The original URL must start with http:// or https://. • The preview QR element is a placeholder, not a scannable code. • Expired links stop resolving without deleting their record and stats.

Related links

تواصل معنا على واتساب