CitraClient.Schemas.OpticalObservationHistoryResponse (citra_client v0.3.0)

View Source

Response containing historical optical observation data.

Fields

  • :data_points — list of CitraClient.Schemas.OpticalObservationHistoryPoint.t() (API key: dataPoints) — Historical optical observation data points sorted by epoch
  • :end_before — DateTime.t() (API key: endBefore) — Query end time (exclusive)
  • :message — String.t() — Status message for async or error states
  • :providers — map() — Map of user_group_id to provider name for data source identification
  • :query_id — String.t() (API key: queryId) — Query execution ID for async retrieval
  • :query_time_ms — integer() (API key: queryTimeMs) — Total endpoint response time in milliseconds
  • :satellite_id — UUID String.t() (API key: satelliteId) — Satellite ID filter (if applied)
  • :start_after — DateTime.t() (API key: startAfter) — Query start time (exclusive)
  • :status — String.t() — Query status: 'success', 'running', or 'error'
  • :telescope_id — UUID String.t() (API key: telescopeId) — Telescope ID filter (if applied)
  • :telescopes — map() — Map of telescope_id to telescope name for sensor identification
  • :total_count — integer() (API key: totalCount) — Total number of data points returned

Summary

Types

t()

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.

Types

t()

@type t() :: %CitraClient.Schemas.OpticalObservationHistoryResponse{
  data_points: [
    CitraClient.Schemas.OpticalObservationHistoryPoint.t() | map() | nil
  ],
  end_before: DateTime.t() | nil,
  message: String.t() | nil,
  providers: map() | nil,
  query_id: String.t() | nil,
  query_time_ms: integer() | nil,
  satellite_id: String.t() | nil,
  start_after: DateTime.t() | nil,
  status: String.t() | nil,
  telescope_id: String.t() | nil,
  telescopes: map() | nil,
  total_count: integer() | nil
}

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.