This is a Jitsu.Classic documentation. For the lastest version, please visit docs.jitsu.com. Read about differences here.

πŸ“œ Configuration

Configuration UI

πŸ‘©β€πŸ”¬ Extending Jitsu

Overview
Destination Extensions
Source Extensions
API Specs

Jitsu Internals

Jitsu Server

Bulk API

Jitsu has events bulk API. The endpoint can consume ~50,000 events in one HTTP request and store them into destinations synchronously. Common use case is uploading archive files with analytics events, which Jitsu writes when events stream from JS SDK or API is stored. For reloading archive files you can use Jitsu CLI.

POST/api/v1/events/bulk?token=$server_api_key_secret

Authorization server secret token might be provided either as query parameter or HTTP header

Parameters

X-Auth-Token
required
header
string
Server secret token
token
required
Query String Parameter
string
Server secret token
fallback
optional
Query String Parameter
boolean
Set true if provided file contains fallback format
skip_malformed
optional
Query String Parameter
boolean
Option for skipping malformed events while processing fallback=true. Default value is false means that all events batch won't be processed if it contains any malformed event.
Content-Type
required
header
string
multipart/form-data

Request Payload

Events should be formatted with \n delimiter (1 event per line):

{"field1": 1, "field2": "value"}\n
{"field3": 999}\n
{"field4": "value3", "field5": 123}

Payload should be sent as multipart form data in field with name file. For reducing network costs, request can be compressed with Content-Encoding gzip.

Response

{"status": "ok"}