Create Event

post

https://preview.threekit.com/api/analytics/events

Create an event and return the details

Query Params

bearer_token

string

Public access token used to authorize the request. Requests may only come from the token's allowed domains. This parameter is mandatory when making requests from a browser. Outside of the browser instead supply a bearer header using a private access token.

orgId

string

Retrieve list of products of a particular organization. For the token's organization, it retrieves the list of all products. For a public organization it retrieves the list of shared products.

Body Params

Event creation fields

eventType

string

enum

required

Specify the type of event to be stored. The supported event types ar listed below

eventMetadata

object

User defined event related metadata

orgId

string

required

ID of the org linked to the event

assetId

string

ID of the asset linked to the event

userId

string

ID of the user using the session linked to the event

sessionId

string

required

ID of the session linked to the event

configId

string

ID of the configuration of a product. This can either be the short ID or the complete UUID of the configuration stored in configurations-service

configuration

object

Complete configuration object of a product. This can be used in place of configId place as well

device

string

This is the device being used for the session linked to the event. By default it will be extracted from the User-Agent header present in a request

metric

number

Can be used to store arbitrary metric for an event. It defaults to 1 if not provided. Numbers with decimal places are supported

Responses

Language

Credentials

Bearer

Response

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

application/json

200Create an event successfully and return it's details

422Request to create an event with an invalid parameter value