Quick Start

Get your first Tolinku API call working in under 5 minutes.

Prerequisites

• A Tolinku account (sign up free)
• An Appspace with at least one route configured
• An API key (create one in API Keys in the sidebar)

1. Get your API key

Go to API Keys in your Appspace dashboard and create a key:

• Publishable key (tolk_pub_): Use in client-side code (browser, mobile app)
• Secret key (tolk_sec_): Use in server-side code only

For this quick start, create a secret key so you can access all endpoints.

2. Make your first request

Fetch your app’s analytics overview:

curl

curl -H "X-API-Key: tolk_sec_your_secret_key" \
  https://your-app.tolinku.com/v1/api/analytics/overview

JavaScript

const res = await fetch('https://your-app.tolinku.com/v1/api/analytics/overview', {
  headers: { 'X-API-Key': 'tolk_sec_your_secret_key' }
});
const data = await res.json();
console.log(data);

Python

import requests

res = requests.get(
    'https://your-app.tolinku.com/v1/api/analytics/overview',
    headers={'X-API-Key': 'tolk_sec_your_secret_key'}
)
print(res.json())

Response:

{
  "total_clicks": 10041,
  "total_installs": 1401,
  "conversion_rate": 14.0,
  "days": 30
}

3. Track a custom event

Send a custom event from your app or server:

curl -X POST https://your-app.tolinku.com/v1/api/analytics/track \
  -H "X-API-Key: tolk_pub_your_publishable_key" \
  -H "Content-Type: application/json" \
  -d '{"event_type": "custom.signup_complete", "properties": {"user_id": "user_123"}}'

Response:

{ "ok": true }

Tip

Custom event types must start with custom. and use only lowercase letters, numbers, and underscores (e.g. custom.purchase, custom.level_up).

4. Install an SDK

For client-side integration, install the SDK for your platform:

Web

npm install @tolinku/web-sdk

import { Tolinku } from '@tolinku/web-sdk';

const tolinku = new Tolinku({ apiKey: 'tolk_pub_your_key' });
tolinku.track('custom.page_view');

iOS

Add via Xcode: File > Add Package Dependencies > https://github.com/tolinku/ios-sdk

import TolinkuSDK

let tolinku = try Tolinku.configure(apiKey: "tolk_pub_your_key")
tolinku.track("custom.app_open")

Android

build.gradle.kts

implementation("com.tolinku:sdk:0.1.0")

import com.tolinku.sdk.Tolinku

Tolinku.configure(apiKey = "tolk_pub_your_key", context = this)
Tolinku.track("custom.app_open")

Next steps

• API Reference: Full endpoint documentation
• SDK Guides: Detailed SDK setup for each platform
• Universal Links: Set up iOS deep linking
• App Links: Set up Android deep linking
• Ecommerce Analytics: Track purchases, revenue, and conversion funnels