Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.userpilot.com/llms.txt

Use this file to discover all available pages before exploring further.

These APIs allow you to identify users and companies, update their profiles in bulk, and track custom events in real time. Integrate these endpoints with your backend or service to keep your Userpilot data up-to-date and actionable.

​
Endpoints

  • Identify User: Create or update individual user profiles, or update multiple users in bulk. Useful for onboarding, profile updates, and large-scale data syncs.
  • Identify Company: Create or update individual company profiles, or update multiple companies in bulk. Ideal for B2B platforms and company-level analytics.
  • Track Event: Record custom events for users to monitor engagement, feature usage, and more.

​
Rate Limits

The real-time HTTP APIs enforce rate limiting to ensure optimal performance and fair usage across all applications. Understanding these limits helps you design robust integrations that work efficiently within the platform’s constraints.

​
Rate Limit Details

  • HTTP Identify API: 600 requests per minute per application token
  • HTTP Track Events API: 600 requests per minute per application token

​
Error Responses

When you exceed these limits, the API returns:
  • 429 Too Many Requests: Returned when you exceed the 600 requests per minute limit

​
Best Practices

Implement Exponential Backoff: When you receive a 429 error, wait progressively longer before retrying (e.g., 1s, 2s, 4s, 8s).Monitor Your Usage: Track your request patterns to stay within limits and optimize your integration performance.Handle Errors Gracefully: Always implement proper error handling for rate limit responses in your applications.