Analytics API

The Analytics API provides access to click data, geographic information, and performance metrics for your links.

Get Link Analytics

Retrieve analytics for a specific link.

GET /v1/analytics/{link_id}?period=7d

Query Parameters

Response

{
  "link_id": "link_abc123",
  "period": "7d",
  "summary": {
    "total_clicks": 1542,
    "unique_clicks": 892,
    "avg_daily_clicks": 220
  },
  "clicks_over_time": [
    { "date": "2024-01-15", "clicks": 245, "unique": 142 },
    { "date": "2024-01-16", "clicks": 198, "unique": 121 },
    { "date": "2024-01-17", "clicks": 312, "unique": 189 }
  ]
}

Geographic Data

Get clicks grouped by country, region, or city.

GET /v1/analytics/{link_id}/geo?group_by=country

Query Parameters

Response

{
  "link_id": "link_abc123",
  "group_by": "country",
  "data": [
    { "country": "US", "country_name": "United States", "clicks": 542, "percentage": 35.2 },
    { "country": "GB", "country_name": "United Kingdom", "clicks": 234, "percentage": 15.2 },
    { "country": "DE", "country_name": "Germany", "clicks": 189, "percentage": 12.3 },
    { "country": "FR", "country_name": "France", "clicks": 156, "percentage": 10.1 }
  ]
}

Device & Browser Data

Analyze clicks by device type, browser, and operating system.

GET /v1/analytics/{link_id}/devices

Response

{
  "link_id": "link_abc123",
  "devices": [
    { "type": "mobile", "clicks": 892, "percentage": 57.8 },
    { "type": "desktop", "clicks": 534, "percentage": 34.6 },
    { "type": "tablet", "clicks": 116, "percentage": 7.5 }
  ],
  "browsers": [
    { "name": "Chrome", "clicks": 687, "percentage": 44.6 },
    { "name": "Safari", "clicks": 423, "percentage": 27.4 },
    { "name": "Firefox", "clicks": 189, "percentage": 12.3 }
  ],
  "os": [
    { "name": "iOS", "clicks": 534, "percentage": 34.6 },
    { "name": "Android", "clicks": 445, "percentage": 28.9 },
    { "name": "Windows", "clicks": 312, "percentage": 20.2 }
  ]
}

Referrer Data

See where your traffic is coming from.

GET /v1/analytics/{link_id}/referrers?limit=10

Response

{
  "link_id": "link_abc123",
  "referrers": [
    { "source": "twitter.com", "clicks": 423, "percentage": 27.4 },
    { "source": "linkedin.com", "clicks": 312, "percentage": 20.2 },
    { "source": "direct", "clicks": 289, "percentage": 18.7 },
    { "source": "facebook.com", "clicks": 198, "percentage": 12.8 }
  ]
}

Bulk Analytics

Get analytics for multiple links at once.

POST /v1/analytics/bulk

{
  "link_ids": ["link_abc123", "link_def456", "link_ghi789"],
  "period": "7d",
  "metrics": ["clicks", "unique_clicks", "top_countries"]
}

Response

{
  "data": [
    {
      "link_id": "link_abc123",
      "clicks": 1542,
      "unique_clicks": 892,
      "top_countries": ["US", "GB", "DE"]
    },
    {
      "link_id": "link_def456",
      "clicks": 876,
      "unique_clicks": 534,
      "top_countries": ["US", "CA", "AU"]
    }
  ]
}