Quick Start

Get AttributeHQ running in your app in 5 minutes.

Create an Account

Go to attributehq.com and click Sign Up. Enter your name, email, password, and company name to create your organization.

Register Your App

In the dashboard, navigate to Apps → Create App. Select your platform (iOS, Android, or Web), fill in the required details (bundle ID, package name, or domain), and save. Copy the App ID — you’ll need it for SDK initialization.

Generate an API Key

On your app’s page, go to API Keys → Generate Key. Give it a name (e.g., “Production SDK Key”) and copy the full key immediately.

The API key is shown only once. Copy and store it securely before closing the dialog.

Install the SDK

Web


npm install @attributehq/web-sdk

iOS

Add to your Package.swift dependencies:


.package(url: "https://github.com/AttributeHQ/ios-sdk.git", from: "1.0.0")

Android

Add JitPack to your project-level build.gradle or settings.gradle.kts:


repositories {
    maven { url "https://jitpack.io" }
}

Then add to your app’s build.gradle:


implementation 'com.github.AttributeHQ:android-sdk:1.0.0'

React Native


npm install @attributehq/react-native-sdk
cd ios && pod install

Initialize and Track

Web (JavaScript)


import { init, track, trackRevenue } from '@attributehq/web-sdk'
 
// Initialize on page load
init({
  apiKey: 'ak_your_api_key',
  appId: 'your-app-uuid',
})
 
// Track a custom event
track('button_click', { screen: 'home' })
 
// Track revenue
trackRevenue(1500, 'NGN', { product: 'premium_plan' })

iOS (Swift)


import AttributeHQ
 
// In AppDelegate.didFinishLaunchingWithOptions
let config = AttributeHQConfiguration(
    apiKey: "ak_your_api_key",
    appId: "your-app-uuid"
)
try AttributeHQ.shared.initialize(configuration: config)
 
// Track events anywhere
AttributeHQ.shared.track(eventName: "button_click", properties: ["screen": "home"])
 
// Track revenue
AttributeHQ.shared.trackRevenue(amount: 1500, currency: "NGN", properties: ["product": "premium_plan"])

Android (Kotlin)


import com.attributehq.sdk.AttributeHQ
import com.attributehq.sdk.AttributeHQConfiguration
 
// In Application.onCreate()
val config = AttributeHQConfiguration(
    apiKey = "ak_your_api_key",
    appId = "your-app-uuid"
)
AttributeHQ.initialize(this, config)
 
// Track events anywhere
AttributeHQ.track("button_click", mapOf("screen" to "home"))
 
// Track revenue
AttributeHQ.trackRevenue(1500.0, "NGN", mapOf("product" to "premium_plan"))

React Native


import { AttributeHQ } from '@attributehq/react-native-sdk'
 
// In your App component (must await)
await AttributeHQ.initialize({
  apiKey: 'ak_your_api_key',
  appId: 'your-app-uuid',
})
 
// Track events (sync, fire-and-forget)
AttributeHQ.track('button_click', { screen: 'home' })
 
// Track revenue
AttributeHQ.trackRevenue(1500, 'NGN', { product: 'premium_plan' })

That’s it! Installs are automatically tracked on first launch, and you can view attribution data in the dashboard .

Next Steps

Web SDK Guide — Full integration guide for websites
iOS SDK Guide — ATT, IDFA, SKAdNetwork support
Android SDK Guide — Install Referrer, GAID support
React Native SDK Guide — Native bridge with Expo support
API Reference — All 28 REST API endpoints
Attribution — How the attribution waterfall works