OODA Terminal Alerts API

The OODA Terminal Alerts API provides access to real-time and historical operational alerts generated by Ona terminal devices.

Base URL

https://3lpq00xevg.execute-api.af-south-1.amazonaws.com/prod

Authentication

Authentication is handled via the x-api-key header.

x-api-key: YOUR_API_KEY

Data Discovery

Get Data Period

GET /ooda/data-period

Discover the time range for which OODA alerts are available.

Parameters

| Parameter | Type | Required | Description | |———–|——|———-|————-| | site_id | string | Yes | Site identifier. | | terminal_device_id | string | No | Optional filter for a specific device. |

from ona_platform import OnaClient

client = OnaClient(ooda_terminal_api_key="your_key")
period = client.ooda_terminal.get_data_period(site_id="Sibaya")
print(f"Alerts from {period['first_record']} to {period['last_record']}")

const { OnaSDK } = require('@asoba/ona-sdk');

const sdk = new OnaSDK({ oodaTerminalApiKey: 'your_key' });
const period = await sdk.oodaTerminal.getDataPeriod({ site_id: 'Sibaya' });
console.log(`Alerts from ${period.first_record} to ${period.last_record}`);

Querying Alerts

Get Terminal Alerts

GET /ooda/terminal

Retrieve historical alerts for a specific terminal device.

Parameters

| Parameter | Type | Required | Description | |———–|——|———-|————-| | terminal_device_id | string | Yes | Terminal device identifier. | | site_id | string | Yes | Site identifier. | | start | string | Yes | ISO 8601 start timestamp. | | end | string | Yes | ISO 8601 end timestamp. |

from ona_platform.models.ooda import TimeRange

alerts = client.ooda_terminal.get_terminal_alerts(
    terminal_device_id="TERM-123",
    site_id="Sibaya",
    time_range=TimeRange(start="2025-01-01T00:00:00", end="2025-01-01T12:00:00")
)

const alerts = await sdk.oodaTerminal.getTerminalAlerts({
  terminal_device_id: 'TERM-123',
  site_id: 'Sibaya',
  start: '2025-01-01T00:00:00',
  end: '2025-01-01T12:00:00'
});