Track

post

https://heapanalytics.com/api/track

Use this API to send custom events to Heap server-side. We recommend using this for events that need to exactly match your backend, such as completed order transaction info, or events that are not available for Heap to capture on the client-side.

NOTE: It is required that you use either the identity or user_id param, but not both.

Body Params

app_id

string

required

The environment ID corresponding to one of your environments.

event

string

required

The name of the server-side event. Limited to 1024 characters.

identity

string

An identity, typically corresponding to an existing user. If no such identity exists, then a new user will be created with that identity. Case-sensitive string, limited to 255 characters.

user_id

string

The user_id from the Heap SDK. The user_id must be the string representation of a number between zero and 2^53 - 1. user_id may be specified instead of identity, but both cannot be provided at the same time.

session_id

string

An identifier corresponding to a user's session

properties

object

An object with key-value properties you want associated with the event. Each key and property must either be a number or string with fewer than 1024 characters.

timestamp

string

ISO8601 e.g. "2017-03-10T22:21:56+00:00". Defaults to the current time if not provided.

idempotency_key

string

A unique ID that will be hashed to Heap's event ID keyspace, to prevent duplication of events. Subsequent calls with the same idempotency key will not update data.

Responses

Language

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400