Public API Documentation

Shorten a Public URL

Anyone can use this endpoint to shorten a public URL without authentication.

POST
/api/public/url
POST /api/public/url
Content-Type: application/json

{
  "url": "https://example.com"
}

Fields:

  • url – The full URL you want to shorten.

Response:

  • shortUrl – The shortened public link.
  • stats – The link to access statistics.
  • password – The password required to access stats.
Fetch Public URL Statistics

Use this endpoint to retrieve visit stats for a public URL. Password required.

POST
/api/public/stats
POST /api/public/stats
Content-Type: application/json

{
  "shortId": "abc12345",
  "password": "c1fdb36e-7b54-48f1-8932-932e8b204a85"
}

Fields:

  • shortId – The unique identifier of the short URL.
  • password – The password from the shortening response.

Response:

  • visit_count – Number of visits.
  • last_visited_at – Last time the URL was visited.
  • logs – Array of visit logs including IP, user agent, referrer, and location.