Skip to main content
Version: 0.9.0

LinkAnalyticsResponse

analytics_gatedboolean | nullnullable

Whether analytics data is gated due to tier limits

clicks_over_time object[]required
  • Array [
    • countinteger<int64>required
    Example: 42
    datestringrequired
    Example: 2024-01-15
  • ]
    • gated_reasonstring | nullnullable

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

    link objectrequired
    android_urlstring | nullnullable

    Android-specific destination URL (Business tier feature). Redirects Android users to this URL instead of the default.

    Example: https://play.google.com/store/apps/details?id=com.example
    click_countinteger<int64>required
    Example: 42
    created_atinteger<int64>required
    Example: 1609459200
    created_bystringrequired
    Example: user-123
    desktop_urlstring | nullnullable

    Desktop-specific destination URL (Business tier feature). Redirects desktop users (Windows, macOS, Linux) to this URL instead of the default.

    Example: https://example.com/desktop-app
    destination_urlstringrequired
    Example: https://example.com/very/long/url
    expires_atinteger,null<int64>nullable
    Example: 1640995200
    forward_query_paramsboolean | nullnullable

    Whether to forward visitor query params to the destination (Pro+ only). None = use org default (resolved at KV write time).

    idstringrequired
    Example: link-123456
    ios_urlstring | nullnullable

    iOS-specific destination URL (Business tier feature). Redirects iPhone/iPad users to this URL instead of the default.

    Example: https://apps.apple.com/app/id123456789
    org_idstringrequired
    Example: org-789
    redirect_typestringrequired

    HTTP redirect type: 301 (permanent) or 307 (temporary). Default is 301 for SEO, 307 available on Pro+ plans.

    Example: 301
    short_codestringrequired
    Example: abc123
    statusLinkStatus (string)required

    Possible values: [active, disabled, blocked]

    tagsstring[]required
    Example: ["marketing","social"]
    titlestring | nullnullable
    Example: My Awesome Link
    updated_atinteger,null<int64>nullable
    Example: 1609459300
    utm_params object
    oneOf
    null
    top_countries object[]required
  • Array [
    • countinteger<int64>required
    Example: 25
    countrystringrequired
    Example: US
  • ]
    • top_referrers object[]required
  • Array [
    • countinteger<int64>required
    Example: 15
    referrerstringrequired
    Example: https://google.com
  • ]
    • top_user_agents object[]required
  • Array [
    • countinteger<int64>required
    Example: 10
    user_agentstringrequired
    Example: Mozilla/5.0...
  • ]
    • total_clicks_in_rangeinteger<int64>required
    Example: 150
    LinkAnalyticsResponse
    {
      "analytics_gated": true,
      "clicks_over_time": [
        {
          "count": 42,
          "date": "2024-01-15"
        }
      ],
      "gated_reason": "string",
      "link": {
        "android_url": "https://play.google.com/store/apps/details?id=com.example",
        "click_count": 42,
        "created_at": 1609459200,
        "created_by": "user-123",
        "desktop_url": "https://example.com/desktop-app",
        "destination_url": "https://example.com/very/long/url",
        "expires_at": 1640995200,
        "forward_query_params": true,
        "id": "link-123456",
        "ios_url": "https://apps.apple.com/app/id123456789",
        "org_id": "org-789",
        "redirect_type": "301",
        "short_code": "abc123",
        "status": "active",
        "tags": [
          "marketing",
          "social"
        ],
        "title": "My Awesome Link",
        "updated_at": 1609459300,
        "utm_params": "null"
      },
      "top_countries": [
        {
          "count": 25,
          "country": "US"
        }
      ],
      "top_referrers": [
        {
          "count": 15,
          "referrer": "https://google.com"
        }
      ],
      "top_user_agents": [
        {
          "count": 10,
          "user_agent": "Mozilla/5.0..."
        }
      ],
      "total_clicks_in_range": 150
    }