API Documentation

Complete reference for the Appizer REST API

Complete reference for the Appizer REST API v1.0.

Contents

Base URL

https://api.appizer.com/v1

Overview

The Appizer API provides programmatic access to:

  • Events - Track user actions and behavior
  • Users - Manage user profiles and identities
  • Analytics - Query insights and metrics using natural language or SQL
  • Audiences - Create and manage smart user segments
  • Push Notifications - Send targeted messages with AI-powered automation
  • MCP Server - Model Context Protocol for AI integrations
  • Website Integration - Client-side JavaScript SDK for seamless form integration

Quick Start

1. Get Your API Key

  1. Sign up at appizer.com
  2. Create a new project
  3. Copy your API key from the dashboard

2. Make Your First Request

curl -X POST https://api.appizer.com/v1/events \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "event_name": "test_event",
    "user_id": "user_123",
    "properties": {
      "source": "api_test"
    }
  }'

Authentication

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

Authorization: Bearer YOUR_API_KEY

Security Best Practices:

  • Keep your API keys secure
  • Never expose them in client-side code
  • Use environment variables or secure configuration management
  • Rotate keys regularly

API Sections

Events

Track user actions and custom events for analytics and segmentation.

Users

Manage user profiles, identities, and aliases.

Website Integration

Integrate Appizer with any website using the Web SDK with automatic event tracking.

Analytics

Query analytics data and retrieve metrics.

Audiences

Create and manage smart audience segments.

Push Notifications

Send targeted push notifications to users.

MCP Server

Model Context Protocol for AI integrations.

Rate Limits

API requests are rate limited to ensure service quality:

  • Events API: 1,000 requests per minute
  • Analytics API: 100 requests per minute
  • Other APIs: 500 requests per minute
  • Batch Events: 100 requests per minute (up to 100 events per batch)

See Rate Limits for details.

Error Handling

The API uses standard HTTP status codes:

  • 200 - Success
  • 400 - Bad Request
  • 401 - Unauthorized
  • 404 - Not Found
  • 429 - Rate Limit Exceeded
  • 500 - Internal Server Error

See Error Codes for complete reference.

SDKs

Official SDKs available for:

  • JavaScript/TypeScript: npm install @appizer/sdk
  • Python: pip install appizer
  • iOS: Swift Package Manager or CocoaPods
  • Android: Gradle
  • React Native: npm install @appizer/react-native

Support

Need help?

Previous
Auth Flow
Next
Authentication