CitraClient.Observations (citra_client v0.3.0)

View Source

Generated operations for OpenAPI tag observations.

Summary

Functions

Get Latest Msi Bus Prediction

Get Msi Bus Predictions

Get Optical Observation Counts

Get Optical Observations

Upload Optical Observations

Functions

get_latest_msi_bus_prediction(opts \\ [])

Get Latest Msi Bus Prediction

Get the most recent MSI bus-type prediction for a satellite.

GET /observations/optical/predictions/msi/bus/latest

Options (passed via keyword list)

  • :satellite_id (required) — Satellite ID

get_msi_bus_predictions(opts \\ [])

Get Msi Bus Predictions

Get MSI bus-type classification predictions for a satellite.

Returns predictions ordered by session_epoch descending, including confidence scores, model version, and the input color indices.

GET /observations/optical/predictions/msi/bus

Options (passed via keyword list)

  • :satellite_id (required) — Satellite ID to get predictions for
  • :limit
  • :offset

get_optical_observation_counts(opts \\ [])

Get Optical Observation Counts

GET /observations/optical/counts

Options (passed via keyword list)

  • :days
  • :show_future

get_optical_observations(opts \\ [])

Get Optical Observations

Query optical observation history over a time range.

By default, returns only hot/recent data. Set includeArchive=true to also query archived cold data from Athena. Results are sorted by epoch in ascending order and filtered by user access level.

Access Control: Results are filtered based on user tier and group membership. Higher tier users can see observations created by lower tier users.

Time Range Limit: When neither satelliteId nor telescopeId is provided, the query is limited to a maximum of 1 hour to prevent massive scans.

For long-running queries, the API may return a 202 status with a queryId. Retry the request with the same queryId to check status and retrieve results.

Datetime format: ISO 8601 (e.g., 2024-01-15T12:00:00Z)

GET /observations/optical

Options (passed via keyword list)

  • :start_after — Return observations after this time (ISO 8601 format)
  • :end_before — Return observations before this time (ISO 8601 format)
  • :satellite_id — Optional satellite ID to filter observations by
  • :telescope_id — Optional telescope/sensor ID to filter observations by
  • :query_id — Query execution ID from a previous request (for async retrieval)
  • :show_all_statuses — If true, return observations with any review status. If false (default), only return approved observations.
  • :fields — Comma-separated list of camelCase field names to include in each dataPoint (e.g. 'epoch,visualMagnitude,solarPhaseAngle'). Use 'all' to return every field. Omit to use the default set.
  • :include_archive — If true, also query archived (cold) data from Athena. Defaults to false, returning only hot/recent data.

upload_optical_observations(body)

Upload Optical Observations

Upload multiple optical observations in a single request.

This endpoint allows Premium users or above to submit multiple optical observations at once. Returns a list of created observation IDs on success.

The solar_phase_angle field is automatically computed from observation geometry (epoch, RA/Dec, sensor position) and cannot be provided by the caller.

POST /observations/optical

Body

Request body (map or generated struct).