Data model
Telemetry records
A telemetry record contains a measurement name, sample time, tags, and fields. POST /telemetry accepts an array of records.
| Property | Meaning |
|---|---|
measurement | Series name, such as satellite, ground_station, or link. |
time | Sample time. Send an ISO 8601 timestamp with a UTC offset. |
tags | String dimensions. Include entity_id: topology keys entities on it, and predictions look up a model's inputs by it. See Models for each model's measurement and fields. |
fields | Measured values: boolean, numeric, or string. Include at least one field. |
Keep field types consistent. Numeric ingestion uses floating-point values; carry identifiers that need exact large-integer precision as strings.
Publish the fields for an entity together at one timestamp. Topology chooses the latest sample and does not merge older fields into it. See Telemetry for validation and acknowledgment behavior.
Topology
GET /topology returns an evaluation time, a request-context tenant_key, and entities. Each entity carries a measurement, ID, observation time, tags, and fields.
When no observed telemetry is available, the endpoint can return approximate simulation geometry. The response's simulation metadata and each generated entity's data_source=simulation tag identify that result. Check provenance before interpreting a value as measured telemetry.
GET /topology/series returns numeric channels aligned to timestamp arrays over a bounded window. See Topology for filters, limits, and continuation.
Predictions
GET /predictions requires named link IDs. It returns available predictions and attempts to compute missing results. Each item includes its link, horizon, prediction time, model identifiers, and numeric values.
Read entity_errors alongside items; a successful HTTP response can contain partial results. captured_at is the response assembly time, while predicted_at identifies the age of each forecast. See Predictions for the complete response and error handling.
Account and deployment context
API credentials identify the caller and grant operation scopes. They do not establish a dedicated data environment for Free or Pro accounts. Tenant isolation is an Enterprise feature. See Security.