Elastic Data Tools
Query custom elastic datasets — user-defined data structures with flexible schemas for tracking any type of operational data beyond the standard emission categories. Each dataset has its own field definitions and records, and can optionally extend a native Dcycle entity (facilities, vehicles, etc.).list_datasets
List all elastic datasets for the organization.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organization_id | string | No | default org | Organization UUID |
| Field | Description |
|---|---|
name | Human-readable dataset name |
slug | URL-friendly identifier |
entity_type | Native Dcycle entity this dataset extends (null for standalone) |
record_count | Number of records in the dataset |
get_dataset
Get a dataset by ID with its full field definitions (schema).
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_id | string | Yes | — | UUID of the dataset |
organization_id | string | No | default org | Organization UUID |
Field data types
Field data types
| Type | Description |
|---|---|
text | Free-form text |
integer | Whole numbers |
decimal | Decimal numbers |
boolean | True/false |
date | Date (YYYY-MM-DD) |
datetime | Date and time |
select | Single choice from predefined options |
reference | UUID reference to another dataset’s record |
quantity_unit | Composite value with unit (e.g. {"value": "12.5", "unit": "kg"}) |
query_dataset
Query records from a dataset with pagination.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_id | string | Yes | — | UUID of the dataset |
organization_id | string | No | default org | Organization UUID |
page | integer | No | 1 | Page number |
size | integer | No | 50 | Results per page |
Records are stored as JSONB — the
data object uses the field key values from the dataset schema. Call get_dataset first to understand what fields exist and their types.Workflow
- Discover datasets —
list_datasetsto see available custom datasets and their record counts - Understand schema —
get_datasetto see field definitions, types, and options - Query records —
query_datasetto retrieve the actual data - Cross-reference — If
entity_typeis set, use the corresponding tool (e.g.list_facilities) to link records to native entities
Related
Custom KPIs
KPI definitions that can be built on elastic datasets
Files
File uploads that can populate elastic datasets