API Specifications

Recording an Event

Method URL:

Method URL/e
http://trk.sandstorm.co/e
https://trk.sandstorm.co/e

Parameters (GET or POST)

Parameters
Data Type
Required
Description

_k

string

Yes

Your API key

_p

255 char string

Yes

Person doing the event

_n

URL-encoded string

Yes

Name of the event

_t

integer

optional

Timestamp in seconds after UTC Unix epoch. Note: you will also need to include _d option listed below for the timestamp to be applied.

_d

0 or 1

optional

Set to 1 if you’re manually passing us the timestamp. It’s used when logging events that occurred in the past.

(Anything)

URL-encoded string

optional

Set an arbitrary value to an arbitrary user property

Example

Sending events or events with properties

http://trk.sandstorm.co/e?_k=api-key&_p=bob&_n=Signed+Up&gender=male&_t=1262304000&_d=1

This records that the user bob did the event Signed Up and his gender was male and this all happened on midnight of January 1, 2010 UTC.

Please be aware of how our processing servers detect duplicate events.

Setting Properties

Method URL:

Method URL/s
http://trk.sandstorm.co/s
https://trk.sandstorm.co/s

Parameters (GET or POST)

Parameters
Data Type
Required?
Description

_k

string

Yes

Your API key

_p

255 char string

Yes

Person doing the event

(Anything)

URL-encoded string

optional

Set an arbitrary value to an arbitrary user property

_t

integer

optional

Timestamp in seconds after UTC Unix epoch

_d

0 or 1

optional

Set to 1 if you’re manually passing us the timestamp. It’s used when logging events that occurred in the past

Example

http://trk.sandstorm.co/s?_k=api-key&_p=bob&gender=male&_t=1262304000&_d=1

This records that the user bob got the property gender with the value set to male and this happened on midnight of January 1, 2010 UTC.

Please be aware of how our processing servers detect duplicate properties.

Aliasing Users

Method URL:

Method URL/a
http://trk.sandstorm.co/a
https://trk.sandstorm.co/a

Parameters (GET or POST)

Parameters
Data Type
Required?
Description

_k

string

Yes

Your API key

_p

255 char string

Yes

One of the person’s identities

_n

255 char string

Yes

Another of the person’s identities

Example

Aliasing

http://trk.sandstorm.co/a?_k=api-key&_p=User+12345&_n=bob%40bob.com

This tells us that events done by User 12345 and events done by bob@bob.com were done by the same person. If you log events or properties to either ID, they all refer back to the same one person.

Calling alias is not reversible, and should be used with some caution.

When to Alias

There are only a handful of scenarios where it is appropriate to directly call alias:

  • You implement Sandstorm using more than one source of data: combining data from an external KM integration, server-side libraries, and/or our JavaScript library.

  • You are identifying people by their email address, and they update their email address within your app.

  • You change your tracking schema to identify people…say, from email address to username.

Last updated