Skip to content

API reference

Link analytics

Get click totals, a daily series and breakdowns by country, city, device, browser and OS for one short link.

GEThttps://ishortn.ink/api/v1/analytics/{alias}

Returns the click analytics for one short link in your personal workspace, over the date range the dashboard allows for your plan: the link's whole history on Pro and Ultra, and Last 7 days on Free.

Request

ParameterInTypeRequiredDescription
aliaspathstringYesThe link's alias.
domainquerystringNoThe link's domain. Defaults to your default domain, or isht.app. See Domains.
curl "https://ishortn.ink/api/v1/analytics/launch-day?domain=isht.app" \
  -H "x-api-key: YOUR_API_KEY"

Response

200 OK. Every clicksPer… field is an object that maps a value to its click count. Values with no clicks are left out, so an object can be empty. When a value can't be detected, its clicks are counted under Unknown. Clicks from known bots aren't recorded.

FieldTypeDescription
totalClicksnumberAll clicks in window, including clicks older than raw-data retention.
verifiedClicksnumberClicks confirmed to come from a real browser. Counted only while verified clicks are on.
clicksPerDateobjectClicks per UTC day, keyed YYYY-MM-DD, oldest first.
uniqueClicksPerDateobjectNew unique visitors per UTC day, keyed YYYY-MM-DD, oldest first.
verifiedClicksPerDateobjectVerified clicks per UTC day.
clicksPerCountryobjectClicks per country name, such as Ghana.
clicksPerCityobjectClicks per city name.
clicksPerContinentobjectClicks per continent name, such as Africa.
clicksPerDeviceobjectClicks per device type, such as mobile, tablet or desktop.
clicksPerOSobjectClicks per operating system.
clicksPerBrowserobjectClicks per browser.
clicksPerModelobjectClicks per device model, such as iPhone.
windowobjectThe date range the numbers cover. days is the plan's range in days, or null for all time. from is the start (ISO 8601), or null for all time. to is the time of the request.

Every number covers only clicks inside window. Raw click data is kept for a limited time on Free and Pro (see Analytics). After that, each day is kept as a daily total. totalClicks, clicksPerDate and uniqueClicksPerDate include those daily totals. The breakdowns and the verified counts cover only the clicks whose raw data is still kept.

{
  "totalClicks": 1284,
  "verifiedClicks": 1102,
  "clicksPerDate": {
    "2026-11-18": 402,
    "2026-11-19": 517,
    "2026-11-20": 365
  },
  "uniqueClicksPerDate": {
    "2026-11-18": 311,
    "2026-11-19": 389,
    "2026-11-20": 254
  },
  "verifiedClicksPerDate": {
    "2026-11-18": 351,
    "2026-11-19": 438,
    "2026-11-20": 313
  },
  "clicksPerCountry": { "Ghana": 640, "Nigeria": 391, "United States": 253 },
  "clicksPerCity": { "Accra": 512, "Lagos": 318, "Kumasi": 128 },
  "clicksPerContinent": { "Africa": 1031, "North America": 253 },
  "clicksPerDevice": { "mobile": 902, "desktop": 361, "tablet": 21 },
  "clicksPerOS": { "Android": 611, "iOS": 291, "Windows": 247, "macOS": 135 },
  "clicksPerBrowser": { "Chrome": 803, "Mobile Safari": 288, "Edge": 193 },
  "clicksPerModel": { "Unknown": 853, "iPhone": 291, "SM-A546E": 140 },
  "window": { "days": null, "from": null, "to": "2026-11-20T18:04:11.512Z" }
}

Errors

StatusBodyCause
401Invalid or missing API keySee Authentication.
403Domain not available for this API keydomain isn't a platform domain or an active custom domain in your personal workspace.
404Link not foundNo link with that alias on that domain in your personal workspace.
429Rate limit exceeded. Retry in N seconds.See Rate limits.

Something missing or unclear? Email support@ishortn.ink.