POST
/
analytics
/
track
curl --request POST \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/analytics/track \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "event": "<string>",
  "type": "<any>",
  "userId": "<string>",
  "channel": "<any>",
  "context": {
    "ip": "<string>",
    "userAgent": "<string>"
  },
  "properties": {},
  "messageId": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "sentAt": "2023-11-07T05:31:56Z"
}'
{
  "message": "<string>",
  "success": true
}

Authorizations

​
Authorization
string
header
required

Access token

Body

application/json

Model for analytics event

​
event
string
required

event name

​
type
any
required
​
userId
string
required

commercengine user id

​
channel
any
required
​
context
object
required
​
properties
object
required

properties of the event

​
messageId
string
required

unique hash string.

​
timestamp
string
required

timestamp when event occured

​
sentAt
string
required

time when event sent to server

Response

200 - application/json
OK
​
message
string
​
success
boolean