Welcome to Userpilot’s API documentation! This guide provides a comprehensive overview of our API suite, helping you understand the different ways to integrate with Userpilot, what each API is best suited for, and how to get the most out of our platform’s capabilities.

​
What You’ll Find in This Documentation

Userpilot offers a comprehensive set of APIs to help you:
  • Identify users and companies in real time
  • Track custom events as they happen
  • Import large volumes of historical data
  • Export analytics data for external analysis
  • Bulk update user and company profiles
  • Delete user and company data for compliance
Our documentation is structured to help you quickly find the right API for your use case, understand the required payloads and endpoints, and follow best practices for reliable, secure integration.

​
API Features and Documentation

​
1. Core API Documentation

Essential Resources:

​
2. Real-time HTTP APIs

Purpose: Instantly recognize users and track their actions as they occur. Best for: Live personalization, in-app experiences, and up-to-the-minute analytics. Documentation: Endpoints: /v1/identify, /v1/track, /v1/companies/identify

​
3. Bulk Data Import API

Purpose: Efficiently backfill or migrate large sets of historical event data. Best for: One-time migrations, data warehouse replays, or importing years of past activity. Documentation: Endpoint: /v1/imports Features: Supports CSV and NDJSON formats, job status monitoring, error handling

​
4. Bulk Data Export API

Purpose: Export analytics data from Userpilot for external analysis and reporting. Best for: Data warehouse integration, custom analytics, compliance reporting. Documentation: Endpoint: /api/v1/analytics/exports Features: Date range filtering, user/company filtering, JSON/CSV formats, email notifications

​
5. Data Deletion API

Purpose: Delete user and company data to comply with privacy regulations like GDPR. Best for: Privacy compliance, data cleanup, user data removal requests. Documentation:
  • Delete Overview - Complete guide to data deletion
  • Features: Scheduled deletions, batch operations, compliance support
Endpoints: /v1/users, /v1/companies

​
How to Choose the Right API

Use CaseRecommended APIDocumentation
Live user trackingReal-time HTTP APIsHTTP API
Historical data migrationBulk Import APIImport Overview
Data analysis & reportingBulk Export APIExport Overview
Profile updatesReal-time HTTP APIsBulk Identify & Update
Privacy complianceData Deletion APIDelete Overview

​
Getting Started

  1. Start with authentication: Review Authentication and Environment setup
  2. Choose your use case: Use the table above to identify the right API
  3. Read the overview: Each API section has a comprehensive overview page
  4. Follow examples: Each endpoint includes detailed request/response examples
  5. Check best practices: Look for best practices guides in each section

​
Best Practices Highlighted

Throughout the documentation, you’ll find tips on:
  • Rate limits and payload sizing
  • Idempotency and deduplication
  • Secure API key management
  • Monitoring and retrying failed jobs
  • Optimizing data sync cadence
  • Error handling and validation

​
Support and Further Help

If you have questions or run into issues: