Events API

Ingest a new user event

post

Authorizations

WriteOnlyBearerAuth

AuthorizationstringRequired

Your Integration API Write Only API Key. Note: You must use the Write Only API Key, not the Read + Write API Key when using this key in a public website or app for frontend analytics tracking.

Query parameters

locationEnrichmentbooleanOptional

Body

application/json

userIdstringOptionalExample: {userId} or null

anonymousIdstringOptionalExample: {anonymousId} or null

namestringOptionalExample: name_of_the_event

timestampnumberOptionalExample: 1690111645853

propertiesobjectOptional

Responses

204

Successful Response

No content

post

/event/ingest

HTTPcURLJavaScriptPython

POST /event/ingest HTTP/1.1
Host: integration-api.userflux.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "userId": "{userId} or null",
  "anonymousId": "{anonymousId} or null",
  "timestamp": 1690111645853,
  "name": "event_name",
  "properties": {
    "property1": "value",
    "property2": 123,
    "property3": true,
    "property4": null,
    "property5": {
      "nestedProperty1": "value"
    }
  }
}

204

Successful Response

No content

Ingest a batch of user events

post

Authorizations

WriteOnlyBearerAuth

AuthorizationstringRequired

Your Integration API Write Only API Key. Note: You must use the Write Only API Key, not the Read + Write API Key when using this key in a public website or app for frontend analytics tracking.

Query parameters

locationEnrichmentbooleanOptional

Body

application/json

Responses

204

Successful Response

No content

post

/event/ingest/batch

HTTPcURLJavaScriptPython

POST /event/ingest/batch HTTP/1.1
Host: integration-api.userflux.co
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 251

{
  "events": [
    {
      "userId": "{userId} or null",
      "anonymousId": "{anonymousId} or null",
      "timestamp": 1690111645853,
      "name": "event_name",
      "properties": {
        "property1": "value",
        "property2": 123,
        "property3": true,
        "property4": null,
        "property5": {
          "nestedProperty1": "value"
        }
      }
    }
  ]
}

204

Successful Response

No content

The Batch endpoint accepts up to 50 events per request