Skip to main content
The iOS SDK calls this API for you. Use it directly to send events from your backend, from another platform, or with property types the SDK can’t send (numbers and booleans).

Base URL

Authentication

Send the app’s ingest key as a bearer token:
The key can only write. A missing, revoked or malformed key gets the same 401 {"error": "unauthorized"}, with no detail about which.

The device object

Every request carries the device it comes from. install_id identifies the install; the other fields update what we know about it.
string
required
A stable id for this install of your app, at most 128 characters. Generate a UUID on first launch and keep it.
string
IANA timezone, like America/New_York. Used for quiet hours.
string
string
string
For example ios.
string
One of notDetermined, denied, authorized, provisional, ephemeral. Any other value is ignored, not rejected.

Errors

Requests are limited to 4 MB.