Record events

Stores a batch of analytics events. Sent by the handler you mounted in your own app, which validates them against your tracking plan first. Query strings are reduced to their campaign parameters on the way in.

POST/events

Request body

requiredapplication/json

contextobject

default: {}

metadataobject

default: {}

Show properties

visitorstring

countrystring

regionstring

citystring

browserstring

osstring

devicestring

Allowed:desktopmobiletablet

eventsobject[]required

min items 1 · max items 100

Show properties

Array of object

namestringrequired

min length 1 · max length 120

propsobject

default: {}

timestampintegerrequired

min 0 · max 9007199254740991

urlstring

referrerstring

Responses

200OK

acceptedintegerrequired

min -9007199254740991 · max 9007199254740991

401401

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Authentication required. Pass an organization API key in the `x-api-key` header."

dataany

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

429429

One of:

object

definedanyrequired

codeanyrequired

statusanyrequired

messagestringrequired

default: "Too many requests. Try again shortly."

dataany

object

definedanyrequired

codestringrequired

statusnumberrequired

messagestringrequired

dataany

Request

curl -X POST "https://stetcms.com/api/v1/events" \
  -H "Content-Type: application/json" \
  -d '{
  "context": {},
  "metadata": {},
  "events": [
    {
      "name": "string",
      "props": {},
      "timestamp": 0,
      "url": "string",
      "referrer": "string"
    }
  ]
}'

const response = await fetch("https://stetcms.com/api/v1/events", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "context": {},
  "metadata": {},
  "events": [
    {
      "name": "string",
      "props": {},
      "timestamp": 0,
      "url": "string",
      "referrer": "string"
    }
  ]
})
});

Response

{
  "accepted": 0
}