Skip to content

Record Processing API (1.0.5)

API for receiving individual records for processing in batches.

All POST requests with a body must be sent as valid JSON with the Content-Type: application/json header.

Clients can send records to the API through the /records/send endpoint. Records are grouped into a "batch" and processed based on the chosen batchDuration strategy.

  • short (default): Records are collected in a temporary batch. If no new records are received for that batch within a 60-second window, the batch is closed and processed into a CSV file.
  • long: Records are collected persistently over a longer period and processed at a fixed, scheduled time (e.g., daily, weekly, or monthly).
Download OpenAPI description
OPENAPI.json
OPENAPI.yaml
Languages
Servers
Mock server

https://pioneer-api-v1.redocly.app/_mock/openapi/

Testing Server

https://api.pioneerdm.com/

Production Server

https://api.v1.pioneerdm.com/

General

General API information

Operations

Check API Status

Request

Returns a simple message indicating the API is running.

curl -i -X GET \
  https://pioneer-api-v1.redocly.app/_mock/openapi/

Responses

Successful connection

Bodyapplication/json
messagestringrequired
Example: "Successfully connected to the records API."
connectedbooleanrequired
Example: true
Response
application/json
{
  "message": "Successfully connected to the records API.",
  "connected": true
}

Records

Operations for sending records and retrieving processed upload status

Operations