Reference¶
Reference documentation is information-oriented. It provides precise technical descriptions of every module, class, and function in the SDK, alongside Django QuerySet examples for the backend schema.
API Reference¶
Auto-generated documentation pulled from source code docstrings:
| Module | Description |
|---|---|
| Results API | ResultsAPI — the primary HTTP client. |
| Models | Pydantic data models: AnalysisDefinition, ResultSeries, ResultQuery, etc. |
| Analyses | Concrete analysis implementations and the BaseAnalysis mixin. |
| Services | ResultsService, ApiResultsRepository, and helper functions. |
| Plotting | Plot strategies, theme helpers, and response builders. |
| Serializers | DjangoAnalysisSerializer, DjangoResultSerializer. |
| Protocols | Runtime-checkable protocols defining the SDK contract. |
| Utilities | Helper functions for logging and token loading. |
Query Examples¶
Django QuerySet examples for the backend schema, showing how the SDK filters map to the underlying ORM:
| Page | Scope |
|---|---|
| Analysis Queries | Querying and traversing Analysis rows. |
| Result Queries | Querying Result rows, ArrayField, and JSONField. |
| Location & Geometry Queries | Project sites, locations, asset locations, and geometry hierarchy. |