Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Jitsu Ingestion API

The Ingestion API from Jitsu — 2 operation(s) for ingestion.

Jitsu Ingestion API is one of 2 APIs that Jitsu publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Ingestion. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, https://use.jitsu.com.

2 operations 2 paths 3 schemas 2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://use.jitsu.com
Authentication
API Key, HTTP Basic
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Jitsu Ingestion API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Write-Key (WriteKeyHeader). It accepts HTTP basic authentication (WriteKeyBasic). By default, every request must be authenticated.

  • WriteKeyHeader — Write Key in the form keyId:keySecret.
  • WriteKeyBasic — HTTP Basic auth with the Write Key as the username (password empty).

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 POST. Each is listed below with its method, path, parameters, and response codes.

Ingestion 2
POST
/api/s/{type}
Ingest a single browser event of the given type.
ingestEvent 2 params body → 200401
POST
/api/s/s2s/{type}
Ingest a single server-to-server event of the given type.
ingestServerEvent 2 params body → 200401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Event (10 properties), Context (8 properties), IngestResponse (2 properties). Each schema is shown below with its type and property counts.

Context
object
Contextual metadata attached to an event.
8 properties
IngestResponse
object
Acknowledgement of accepted events.
2 properties
Event
object
A single analytics event following the Segment-style shape.
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jitsu-ingestion-api-openapi.yml Raw ↑

Other APIs Jitsu publishes across the network.

Jitsu Batch API