Log an event

post

https://neon-interact-qa.spika.com/interact/v1/{space}/event

This method is used for logging an arbitrary event from for example a website or App. Performance is of essence, so only basic validation is performed, and it the call returns immediately, saving the event asynchronously in the background.

Path Params

space

string

required

The name of the space (database) assigned to you.

Body Params

entityId

string

required

An Entity that the Event refers to. Mandatory, and must be PUBLISHED on save.

event

string

required

length ≤ 20

The name or type of Event. Freetext and case sensitive. This is often the same as the 'activity' attribute in the Activity table.

specifics

string

length ≤ 50

Optional additional information related to the event field. Freetext and case sensitive. This is normally the same as the 'specifics' attribute in the Activity table.

memberId

string

This is the reference to the Member for which the event takes place. When setting, it can reference any lookup identifier. When reading, it returns the internal member Id. The field is optional to allow the recording of Events which don't relate to a Member. Note, that for performance reasons this field may not be validated when creating the Event.

dimensions

object

The Dimensions applicable to the Event, if any. Note that the Dimensions may not be validated when the event if created.

data

object

Optional additional data related to the Event.

attribution

object

Optional additional information about how the event was triggered, for example utm_ parameters.

Response

200

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here!