API Reference

RESTful API for tracking events, managing websites, and accessing analytics data

Quick Start

Install via npm:

npm install @tinytapanalytics/sdk

Or via yarn:

yarn add @tinytapanalytics/sdk

Basic Usage

import { TinyTapAnalytics } from '@tinytapanalytics/sdk';

// Initialize the SDK
const analytics = new TinyTapAnalytics({
  apiKey: 'your-api-key',
  websiteId: 'your-website-id'
});

// Track custom events
analytics.trackEvent('checkout_started', {
  cartValue: 99.99,
  itemCount: 3
});

// Track page views
analytics.trackPageView();

// Identify users
analytics.identify({
  userId: 'user-123',
  email: 'user@example.com'
});

REST API Endpoints

POST/api/v1/events

Track custom events

{
  "eventType": "checkout_started",
  "websiteId": "website-123",
  "sessionId": "session-456",
  "metadata": {
    "cartValue": 99.99,
    "itemCount": 3
  }
}

GET/api/v1/analytics/metrics

Get analytics metrics for a time range

Query Parameters:
- timeRange: "7d" | "30d" | "90d"
- websiteId: string (optional)

Response:
{
  "totalEvents": 15234,
  "rageClicks": 234,
  "cartAbandonments": 89,
  "conversionRate": 2.3
}

POST/api/v1/websites

{
  "domain": "mystore.com",
  "name": "My Store",
  "platform": "shopify"
}

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header:

Authorization: Bearer your-api-key

Rate Limits

Starter

1,000/hour

Event tracking requests

Growth

10,000/hour

Event tracking requests

Enterprise

Custom

Official SDKs

JavaScript/TypeScript

@tinytapanalytics/sdk v3.0.0

npm install @tinytapanalytics/sdk

React

React hooks and components

npm install @tinytapanalytics/react

Vue

Vue 3 plugin and composables

npm install @tinytapanalytics/vue

PHP

WordPress/WooCommerce ready

composer require tinytapanalytics/php-sdk