Skip to main content

API Overview

The UpsellSDK API is a REST API used by the JavaScript SDK and React components.

Base URL

https://api.upsellsdk.com

Authentication

All SDK endpoints require an API key passed in the X-API-Key header:

curl -X POST https://api.upsellsdk.com/sdk/track \
-H "X-API-Key: us_your_api_key" \
-H "Content-Type: application/json" \
-d '{"eventName": "limit_reached", "properties": {"feature": "projects"}}'

SDK Endpoints

MethodEndpointDescription
POST/sdk/identifyIdentify a user
POST/sdk/trackTrack an event

Admin Endpoints

These endpoints are used by the dashboard:

MethodEndpointDescription
GET/tenantsList all tenants
POST/tenantsCreate a tenant
POST/tenants/{id}/api-keysGenerate API key
GET/usersList tracked users
GET/eventsList tracked events