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

Koala Profile Ingestion API

Endpoints for sending events and traits tied to individual visitors (profiles).

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

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

This API exposes 1 operation across 1 path, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api2.getkoala.com/web/projects/{publicApiKey}.

1 operations 1 paths 6 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api2.getkoala.com
Terms of Service
Resource Areas
1

Paths & Operations 1

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

Profile Ingestion 1

Endpoints for sending events and traits tied to individual visitors (profiles).

POST
/batch
Send profile-level batch events, identifies, and page views
sendProfileBatch 1 param body → 200400401429

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are TrackEvent (5 properties), ProfileBatchRequest (5 properties), PageView (5 properties), IdentifyCall (3 properties). Each schema is shown below with its type and property counts.

BatchResponse
object
Successful batch acceptance response.
1 property
PageView
object
A page view event in the Segment-compatible format.
5 properties 1 required
ProfileBatchRequest
object
Payload for the profile /batch endpoint. Must include at least one of profileid or email. Optionally includes up to 30 each of events, identifies, and pageview…
5 properties
IdentifyCall
object
An identify call carrying visitor-level traits.
3 properties 1 required
ErrorResponse
object
Error response body.
2 properties
TrackEvent
object
A custom track event in the Segment-compatible format.
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

koala-profile-ingestion-api-openapi.yml Raw ↑

Other APIs Koala publishes across the network.

Koala JavaScript SDK & Pixel API
Koala Edge API
Koala Account Ingestion API