Skip to main content
Version: 0.10.0 (stable)

OrgAnalyticsResponse

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")

    top_countries object[]required
  • Array [
  • countinteger<int64>required
    Example: 25
    countrystringrequired
    Example: US
  • ]
  • top_links object[]required
  • Array [
  • countinteger<int64>required
    Example: 50
    custom_domainstring | nullnullable

    Custom domain this link belongs to, if any.

    Example: go.mybrand.com
    link_idstringrequired
    Example: link-123
    short_codestringrequired
    Example: abc123
    titlestring | nullnullable
    Example: My Link
  • ]
  • 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_clicksinteger<int64>required
    Example: 1500
    unique_links_clickedinteger<int64>required
    Example: 75
    OrgAnalyticsResponse
    {
    "analytics_gated": true,
    "clicks_over_time": [
    {
    "count": 42,
    "date": "2024-01-15"
    }
    ],
    "gated_reason": "string",
    "top_countries": [
    {
    "count": 25,
    "country": "US"
    }
    ],
    "top_links": [
    {
    "count": 50,
    "custom_domain": "go.mybrand.com",
    "link_id": "link-123",
    "short_code": "abc123",
    "title": "My Link"
    }
    ],
    "top_referrers": [
    {
    "count": 15,
    "referrer": "https://google.com"
    }
    ],
    "top_user_agents": [
    {
    "count": 10,
    "user_agent": "Mozilla/5.0..."
    }
    ],
    "total_clicks": 1500,
    "unique_links_clicked": 75
    }