Get statistics overview
Retrieve analytics grouped by dimension (country, device, browser, etc.). Filter by short links, domains, folders, or tags.
Multiple dimensions available: Geographic (city, region, country, continent), Technology (device, browser, os, lang), Traffic (referer, UTM params), Other (qrCode, destination, shortLinks)
Authorizations
API Key authentication for programmatic access.
How to use:
- Create an API key from your dashboard settings
- Include the key in the
x-api-keyheader with each request - API keys have granular permissions (domains, shortLinks, files, stats, apiKeys)
Example:
Types of API keys:
- User keys: Linked to your user account (one per organization)
- Bot keys: Autonomous machine users (one per organization)
Security notes:
- Keep your API keys secure and never commit them to version control
- API keys cannot access authentication endpoints (/auth/*)
- Keys can be revoked at any time from the dashboard
Query Parameters
Filter by specific short link UUIDs
Filter by domain UUIDs
Filter by folder UUIDs
Filter by tag UUIDs
Start date for analytics range
"2024-01-01T00:00:00Z"
End date for analytics range
"2024-01-31T23:59:59Z"
Dimension to group results by
city, region, country, continent, lang, device, browser, os, referer, utmSource, utmMedium, utmCampaign, utmTerm, utmContent, qrCode, destination, shortLinks, uniqueVisitors "country"
Limit number of results
1 <= x <= 2010