TypeScript SDK

const domains = await fyn.domains.list({
  page: 1,
  limit: 10
});

const domain = await fyn.domains.get('domain_123');

console.log(domain.domain);
console.log(domain.status);

{
  "id": "domain_123",
  "domain": "go.example.com",
  "description": "Primary branded short domain",
  "isSubdomain": true,
  "userId": "user_99",
  "teams": ["team_7"],
  "status": "pending",
  "notFoundUrl": "https://example.com/404",
  "rootRedirect": "https://example.com",
  "gpc": false,
  "createdAt": "2026-03-20T09:00:00.000000Z",
  "updatedAt": "2026-03-20T09:00:00.000000Z"
}

const created = await fyn.domains.create({
  domain: 'go.example.com',
  description: 'Primary branded short domain',
  notFoundUrl: 'https://example.com/404',
  rootRedirect: 'https://example.com',
  gpc: false
});

{
  "id": "domain_123",
  "domain": "go.example.com",
  "description": "Primary branded short domain",
  "isSubdomain": true,
  "userId": "user_99",
  "teams": ["team_7"],
  "status": "pending",
  "notFoundUrl": "https://example.com/404",
  "rootRedirect": "https://example.com",
  "gpc": false,
  "createdAt": "2026-03-20T09:00:00.000000Z",
  "updatedAt": "2026-03-20T09:00:00.000000Z"
}

const updated = await fyn.domains.update({
  id: 'domain_123',
  description: 'Updated from SDK docs example',
  notFoundUrl: 'https://example.com/not-found',
  rootRedirect: 'https://example.com/home',
  gpc: true
});

{
  "id": "domain_123",
  "domain": "go.example.com",
  "description": "Updated from SDK docs example",
  "isSubdomain": true,
  "userId": "user_99",
  "teams": ["team_7"],
  "status": "active",
  "notFoundUrl": "https://example.com/not-found",
  "rootRedirect": "https://example.com/home",
  "gpc": true,
  "createdAt": "2026-03-20T09:00:00.000000Z",
  "updatedAt": "2026-03-21T08:30:00.000000Z"
}

const verification = await fyn.domains.verify('domain_123');

console.log(verification.verified);
console.log(verification.cname);

{
  "id": "domain_123",
  "domain": "go.example.com",
  "status": "active",
  "verified": true,
  "cname": "cname.fyn.link"
}

await fyn.domains.remove('domain_123');
console.log('Removed domain_123');

const members = await fyn.members.list({
  includeOwner: true
});

{
  "data": [
    {
      "id": "user_123",
      "name": "Alex Doe",
      "email": "member@example.com",
      "role": "editor",
      "displayPicture": "https://cdn.example.com/avatar/alex.png",
      "teamId": "team_7",
      "createdAt": "2026-03-01T11:00:00.000000Z",
      "updatedAt": "2026-03-15T09:00:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "to": 1,
    "per_page": 15,
    "last_page": 1,
    "total": 1
  }
}

await fyn.members.invite({
  email: 'member@example.com',
  role: 'editor'
});

const member = await fyn.members.get('member_123');

console.log(member.email);
console.log(member.role);

{
  "id": "user_123",
  "name": "Alex Doe",
  "email": "member@example.com",
  "role": "editor",
  "displayPicture": "https://cdn.example.com/avatar/alex.png",
  "teamId": "team_7",
  "createdAt": "2026-03-01T11:00:00.000000Z",
  "updatedAt": "2026-03-15T09:00:00.000000Z"
}

const updatedMember = await fyn.members.update({
  id: 'member_123',
  role: 'admin'
});

const currentTeam = await fyn.teams.get();

const updatedTeam = await fyn.teams.update({
  name: 'Growth Team'
});

// fyn.members.update(...)
{
  "id": "user_123",
  "name": "Alex Doe",
  "email": "member@example.com",
  "role": "admin",
  "displayPicture": "https://cdn.example.com/avatar/alex.png",
  "teamId": "team_7",
  "createdAt": "2026-03-01T11:00:00.000000Z",
  "updatedAt": "2026-03-21T10:00:00.000000Z"
}

// fyn.teams.get() and fyn.teams.update(...)
{
  "id": "team_7",
  "type": "team",
  "attributes": {
    "name": "Growth Team",
    "privateLinks": false,
    "safeMode": true,
    "tracking": "full"
  },
  "owner": {
    "id": "user_99",
    "type": "user",
    "name": "Owner Name"
  },
  "defaultDomain": {
    "id": "domain_123",
    "value": "go.example.com"
  },
  "createdAt": "2026-01-01T00:00:00+00:00",
  "updatedAt": "2026-03-21T10:15:00+00:00"
}

await fyn.members.remove('member_123');
console.log('Removed member_123');

const clicks = await fyn.analytics.clicks('link_123');

const analytics = await fyn.analytics.timeseries('link_123', {
  granularity: 'day'
});

{
  "clicks": {
    "id": "link_123",
    "clicks": 120
  },
  "timeseries": {
    "data": [
      {
        "date": "2026-03-01T00:00:00+00:00",
        "clicks": 14,
        "uniqueClicks": 12
      }
    ],
    "meta": {
      "totalClicks": 120,
      "totalUniqueClicks": 95,
      "count": 10
    }
  }
}

const browsers = await fyn.analytics.browsers('link_123', {
  granularity: 'day'
});

const devices = await fyn.analytics.devices('link_123', {
  granularity: 'day'
});

const countries = await fyn.analytics.countries('link_123', {
  granularity: 'day'
});

const referrers = await fyn.analytics.referrers('link_123', {
  granularity: 'day'
});

{
  "browsers": {
    "data": [
      { "browser": "Chrome", "clicks": 58, "percentage": 48.33 }
    ],
    "meta": { "totalClicks": 120, "count": 1 }
  },
  "devices": {
    "data": [
      { "device": "desktop", "clicks": 73, "percentage": 60.83 }
    ],
    "meta": { "totalClicks": 120, "count": 1 }
  },
  "countries": {
    "data": [
      { "country": "United States", "countryCode": "US", "clicks": 64, "percentage": 53.33 }
    ],
    "meta": { "totalClicks": 120, "count": 1, "countriesCount": 1 }
  },
  "referrers": {
    "data": [
      { "referrer": "google.com", "clicks": 66, "percentage": 55.0 }
    ],
    "meta": { "totalClicks": 120, "count": 1, "sourcesCount": 1 }
  }
}

const stats = await fyn.analytics.timeseries('link_123', {
  start: '2026-03-01T00:00:00.000Z',
  end: '2026-03-19T23:59:59.999Z',
  granularity: 'day',
  country: ['US', 'IN'],
  browser: ['Chrome', 'Safari'],
  device: ['desktop', 'mobile'],
  referrer: ['google.com']
});

{
  "data": [
    {
      "date": "2026-03-01T00:00:00+00:00",
      "clicks": 14,
      "uniqueClicks": 12
    }
  ],
  "meta": {
    "totalClicks": 120,
    "totalUniqueClicks": 95,
    "count": 10
  }
}

const info = await fyn.info.get();
const freshInfo = await fyn.info.get(true);

console.log(info.team.defaultDomain.value);
console.log(freshInfo.permissions);

npx tsx examples/analytics/clicks.ts <linkId>
npx tsx examples/analytics/timeseries.ts <linkId>
npx tsx examples/analytics/browsers.ts <linkId>
npx tsx examples/analytics/devices.ts <linkId>
npx tsx examples/analytics/countries.ts <linkId>
npx tsx examples/analytics/referrers.ts <linkId>
npx tsx examples/info/get.ts

{
  "id": "token_abc",
  "user": { "id": "user_99", "name": "Owner Name" },
  "team": {
    "id": "team_7",
    "name": "Growth Team",
    "publicKey": "base64-public-key",
    "disableAnalytics": false,
    "safeMode": true,
    "privateLink": false,
    "defaultDomain": { "id": "domain_123", "value": "go.example.com" },
    "availableDomains": [
      { "id": "domain_123", "value": "go.example.com" },
      { "id": "domain_124", "value": "links.example.com" }
    ]
  },
  "permissions": ["link.read", "link.create", "member.read"],
  "tokenName": "SDK Token"
}