Skip to main content
Version: main (unreleased)

OrgAnalyticsResponse

total_clicksinteger<int64>required
Example: 1500
unique_links_clickedinteger<int64>required
Example: 75
clicks_over_time object[]required
  • Array [
  • datestringrequired
    Example: 2024-01-15
    countinteger<int64>required
    Example: 42
  • ]
  • top_links object[]required
  • Array [
  • link_idstringrequired
    Example: link-123
    short_codestringrequired
    Example: abc123
    titlestring | nullnullable
    Example: My Link
    countinteger<int64>required
    Example: 50
    custom_domainstring | nullnullable

    Custom domain this link belongs to, if any.

    Example: go.mybrand.com
  • ]
  • top_referrers object[]required
  • Array [
  • referrerstringrequired
    Example: https://google.com
    countinteger<int64>required
    Example: 15
  • ]
  • top_countries object[]required
  • Array [
  • countrystringrequired
    Example: US
    countinteger<int64>required
    Example: 25
  • ]
  • top_user_agents object[]required
  • Array [
  • user_agentstringrequired
    Example: Mozilla/5.0...
    countinteger<int64>required
    Example: 10
  • ]
  • analytics_gatedboolean | nullnullable

    Whether analytics data is gated due to tier limits

    gated_reasonstring | nullnullable

    Reason analytics are gated (e.g., "click_limit_exceeded", "retention_limited")

    OrgAnalyticsResponse
    {
    "total_clicks": 1500,
    "unique_links_clicked": 75,
    "clicks_over_time": [
    {
    "date": "2024-01-15",
    "count": 42
    }
    ],
    "top_links": [
    {
    "link_id": "link-123",
    "short_code": "abc123",
    "title": "My Link",
    "count": 50,
    "custom_domain": "go.mybrand.com"
    }
    ],
    "top_referrers": [
    {
    "referrer": "https://google.com",
    "count": 15
    }
    ],
    "top_countries": [
    {
    "country": "US",
    "count": 25
    }
    ],
    "top_user_agents": [
    {
    "user_agent": "Mozilla/5.0...",
    "count": 10
    }
    ],
    "analytics_gated": true,
    "gated_reason": "string"
    }