Station Scoping & Filtering

To manage data across multiple locations, this API uses the station_uuid parameter. Depending on whether you are reading or writing data, the behavior of this parameter changes.

Reading Data (GET Requests)

By default, GET requests are broad-scoped.

  • Default Behavior: If no station_uuid is provided, the API returns data for all stations accessible by your API key.
  • Filtering: To limit the response to a specific location, include the station_uuid as a query parameter.

Writing & Deleting Data (POST, PUT, PATCH,DELTE)

Write and delete operations are context-specific. To ensure data integrity, you should always specify the destination station.

  • Requirement: You must provide the station_uuid in the request body (or as a query parameter, depending on your setup) to identify where the record should be created.
  • Fallback Behavior: If a write request is submitted without a station_uuid, the system will automatically assign the record to the default station associated with your API key at the time of its creation.
🚧

Avoid Ambiguity

Relying on the fallback behavior can lead to data being recorded in the wrong station if your API key has access to multiple stations. We strongly recommend explicitly passing the station_uuid for every write operation.


Parameter Definition

ParameterTypeDescription
station_uuidstring (UUID)The unique identifier for the station. Used as a filter for GET requests and a destination target for write requests.