# Orion Docs

> Documentation for the Orion Data platform: portal guides for monitoring devices and sites, and versioned API references.

Every page is available as Markdown: append `.md` to the page path, or request the page with `Accept: text/markdown`. The complete content of every page listed here is in [llms-full.txt](https://docs.oriondata.io/llms-full.txt). Each API is versioned independently. Use the latest version unless you are maintaining an existing integration.

## Overview

- [API reference](https://docs.oriondata.io/api.md): Integrate Orion Data with your systems. Each API is versioned independently.

## Guides

- [Guides](https://docs.oriondata.io/guides.md): Complete tasks in Orion Data, from signing in and configuring devices to exporting data, creating dashboards and managing access.
- [Manage alarm recipients](https://docs.oriondata.io/portal/alarms/alarm-recipients-managing-who-gets-notified.md): Select notification recipients and add or update recipient records.
- [Create a sensor alarm](https://docs.oriondata.io/portal/alarms/creating-an-alarm-on-a-sensor.md): Create a sensor alarm with a threshold, reset option, recipients and notification message.
- [Configure a sensor alarm](https://docs.oriondata.io/portal/alarms/sensor-alarms-configuring-alerts-on-a-sensor.md): Set an alarm condition, consecutive-reading count, reset type and notification content, then save it.
- [Calibrate a vibrating wire piezometer](https://docs.oriondata.io/portal/calibrations/calibrating-vibrating-wire-piezometers.md): Configure a vibrating-wire conversion chain from frequency to pressure using sensor-specific coefficients.
- [Convert sensor units](https://docs.oriondata.io/portal/calibrations/converting-sensor-units-using-calibrations.md): Create a calibration action that converts a sensor reading into the required measurement unit.
- [Apply a calibration template](https://docs.oriondata.io/portal/calibrations/creating-a-calibration-using-create-from-template.md): Select an existing calibration template, configure its inputs and apply it to a sensor.
- [Apply a daily accumulation template](https://docs.oriondata.io/portal/calibrations/examples/building-a-daily-accumulation-total-with-periodic-reset.md): Apply an existing accumulation-and-reset template and configure its sensor and reset window.
- [Apply a depth-to-water calibration](https://docs.oriondata.io/portal/calibrations/examples/setting-up-a-depth-to-water-dtw-calibration.md): Apply a depth-to-water template to a soft sensor using matching reference measurements.
- [Save a calibration template](https://docs.oriondata.io/portal/calibrations/saving-a-calibration-as-a-template.md): Save configured calibration groups as a template and mark inputs that require per-device values.
- [Create your first calibration](https://docs.oriondata.io/portal/calibrations/setting-up-your-first-calibration.md): Create and check a soft-sensor calibration using a Fahrenheit-to-Celsius worked example.
- [Recalculate historical sensor data](https://docs.oriondata.io/portal/calibrations/using-force-recalculation.md): Start recalculation after changing a calibration so it can be applied to historical readings.
- [Create a dashboard](https://docs.oriondata.io/portal/dashboards/creating-a-dashboard.md): Create a dashboard, give it a name and start adding sensor-data widgets.
- [Add a widget to a dashboard](https://docs.oriondata.io/portal/dashboards/how-to-add-a-widget-to-a-dashboard.md): Add a tile, select its visualisation and sensor series, then save it to a dashboard.
- [Share a dashboard](https://docs.oriondata.io/portal/dashboards/how-to-share-a-dashboard.md): Choose the users who can access a dashboard and save its sharing settings.
- [Assign a device to a client](https://docs.oriondata.io/portal/devices/assigning-a-client-to-a-device.md): Select an existing client in a device configuration and save the assignment.
- [Assign a device to a site](https://docs.oriondata.io/portal/devices/how-to-tag-a-device-to-a-site.md): Select one or more sites in a device configuration and save the assignment.
- [Set a device location](https://docs.oriondata.io/portal/devices/setting-a-devices-installation-location.md): Enter device coordinates, convert them when needed and save the map location.
- [Upload and manage device attachments](https://docs.oriondata.io/portal/devices/uploading-and-managing-device-attachments.md): Upload files to device folders and use the attachment management controls.
- [Create a soft sensor](https://docs.oriondata.io/portal/getting-started/creating-a-soft-sensor.md): Add a soft sensor to a device, select its sensor type and base sensor, then save it.
- [Deactivate a device](https://docs.oriondata.io/portal/getting-started/deactivating-a-device.md): Record a device deactivation, save its status and date, and notify the EWS team.
- [Export sensor data](https://docs.oriondata.io/portal/getting-started/exporting-sensor-data-from-a-device.md): Select a device channel and date range, then export the displayed readings.
- [Log in to Orion Data](https://docs.oriondata.io/portal/getting-started/logging-in-to-orion-data.md): Sign in to Orion Data and get help with password resets or account access.
- [Assign sites to a user](https://docs.oriondata.io/portal/users-and-access/assigning-sites-to-a-user.md): Select site assignments in a user profile and save the updated account.
- [Create a client](https://docs.oriondata.io/portal/users-and-access/creating-a-client.md): Create a named client under the appropriate tenant and save it in User Management.
- [Create a group](https://docs.oriondata.io/portal/users-and-access/creating-a-group.md): Create a named group under a client and save it in User Management.
- [Create a site](https://docs.oriondata.io/portal/users-and-access/creating-a-site.md): Create a named site under the appropriate tenant and save it in User Management.
- [Create a user](https://docs.oriondata.io/portal/users-and-access/how-to-create-a-new-user.md): Enter a user account and its role and organisation assignments, then create it.

## Docs

- [Orion documentation](https://docs.oriondata.io/index.md): Learn Orion Data, follow Guides and ask ChatGPT or Claude to explain the documentation.
- [Orion Data](https://docs.oriondata.io/docs.md): Understand Orion Data features, their settings and how devices, channels, calibrations, alarms and dashboards fit together.
- [Quickstart](https://docs.oriondata.io/docs/quickstart.md): Sign in to Orion Data, find a device and view a channel's readings.
- [Alarm history](https://docs.oriondata.io/portal/alarms/alarm-centre-viewing-and-managing-your-alarm-history.md): Channel alarm-history date ranges, record columns and export controls.
- [Alarm notification settings](https://docs.oriondata.io/portal/alarms/alarm-notification-settings-reference.md): Notification delivery methods, recipient lists, alarm levels and message fields.
- [Alarm conditions and notifications](https://docs.oriondata.io/portal/alarms/how-alarms-work.md): Sensor alarm conditions, consecutive readings, resets, notifications and management permissions.
- [Alarm resets and maintenance](https://docs.oriondata.io/portal/alarms/how-to-acknowledge-or-resolve-an-alarm.md): Automatic alarm resets, channel alert history and controls used during device maintenance.
- [Calibration action step types](https://docs.oriondata.io/portal/calibrations/reference/action-step-types-reference.md): Value, sensor, soft-sensor, previous-step and sliding-window inputs for calibration actions.
- [Calibration aggregates](https://docs.oriondata.io/portal/calibrations/reference/aggregates-reference.md): Sliding-window and global aggregates, their settings, output frequency and boundary behaviour.
- [Calibration conditions](https://docs.oriondata.io/portal/calibrations/reference/calibration-conditions-reference.md): Value, time and date conditions, supported comparisons and calibration-group evaluation rules.
- [Calibration lookup tables](https://docs.oriondata.io/portal/calibrations/reference/lookup-tables.md): Input/output mappings, interpolation, clamping and lookup behaviour in calibration actions.
- [Calibration operators](https://docs.oriondata.io/portal/calibrations/reference/operators-reference.md): Arithmetic, trigonometric and logarithmic calibration operators and their input conventions.
- [Calibrations and sensor values](https://docs.oriondata.io/portal/calibrations/understanding-calibrations.md): Raw and soft-sensor values, transformation groups, conditions, actions and reusable templates.
- [Chart tile settings](https://docs.oriondata.io/portal/dashboards/how-to-configure-a-chart-widget.md): Chart styles, Y-axis scaling, series settings and controls for chart tiles on Orion Data dashboards.
- [Device configuration fields](https://docs.oriondata.io/portal/devices/device-configuration-fields-reference.md): Device identification, location, dates, time-zone, data-rounding and assignment fields.
- [Device configuration](https://docs.oriondata.io/portal/devices/device-configuration-tab.md): Device configuration panels, editable fields, role restrictions and save controls.
- [Sensor Data](https://docs.oriondata.io/portal/devices/device-sensor-data-tab.md): Channel selection, date ranges, graphs, reading tables and export controls in Sensor Data.
- [Devices and watchlist](https://docs.oriondata.io/portal/devices/devices-overview.md): Device-list search, column filters, grid settings and watchlist controls.
- [Battery estimates and replacement dates](https://docs.oriondata.io/portal/devices/orion-database-battery-reset-feature.md): How replacement dates, battery types and device models affect displayed battery estimates.
- [Device list columns and export](https://docs.oriondata.io/portal/devices/the-device-list-finding-and-managing-your-devices.md): Device-list column visibility, search and spreadsheet export controls.
- [Device Health](https://docs.oriondata.io/portal/devices/understanding-the-device-health-tab.md): Telemetry fields, transmission metrics and temperature panels for supported firmware.
- [Channels and soft sensors](https://docs.oriondata.io/portal/devices/using-the-channels-tab.md): Channel fields, visibility, sensor types and soft-sensor controls on a device.
- [Account settings](https://docs.oriondata.io/portal/getting-started/account-settings-overview.md): Profile fields, start-page preferences and sign-in options available in Account Settings.
- [Navigation and user roles](https://docs.oriondata.io/portal/getting-started/navigating-the-orion-data-interface.md): The main navigation, role-dependent menus and available device-list controls.
- [Map search and device details](https://docs.oriondata.io/portal/map/filtering-devices-on-the-map.md): Map clusters, device search, connection markers and the device information panel.
- [Map View](https://docs.oriondata.io/portal/map/understanding-map-view.md): The map canvas, device markers, search and sensor-channel panels in Map View.
- [Profile preferences and security](https://docs.oriondata.io/portal/users-and-access/updating-your-profile-and-account-settings.md): Profile preferences, map appearance, password controls, MFA and recovery-code settings.

## Orion Data API v1.3 (latest)

- [Overview | Orion Data API v1.3](https://docs.oriondata.io/api/orion-data/v1-3.md)
- [Authenticate API requests | Orion Data API v1.3](https://docs.oriondata.io/api/orion-data/v1-3/guides/authentication.md): How to generate an API key in Orion Data, exchange it for a JWT bearer token, and authenticate requests to the Orion Data API.
- [API formats and time zones | Orion Data API v1.3](https://docs.oriondata.io/api/orion-data/v1-3/guides/conventions.md): Date formats, nullable types, and other conventions used throughout the Orion Data API.
- [Orion Data API | Orion Data API v1.3](https://docs.oriondata.io/api/orion-data/v1-3/guides/introduction.md): Overview of the Orion Data API, a read-only HTTP API for extracting Devices and sensor data from Orion Data.
- [API pagination | Orion Data API v1.3](https://docs.oriondata.io/api/orion-data/v1-3/guides/pagination.md): How to page through large result sets using the offset query parameter.
- [API rate limits | Orion Data API v1.3](https://docs.oriondata.io/api/orion-data/v1-3/guides/rate-limiting.md): How the Orion Data API limits request rates and what happens when the limit is exceeded.
- [API status codes | Orion Data API v1.3](https://docs.oriondata.io/api/orion-data/v1-3/guides/status-codes.md): HTTP status codes returned by the Orion Data API and what each one means.
- [API versions and deprecation | Orion Data API v1.3](https://docs.oriondata.io/api/orion-data/v1-3/guides/versioning.md): How to target a specific Orion Data API version and how deprecated endpoints are retired.
- [Get sensor data | Orion Data API v1.3](https://docs.oriondata.io/api/orion-data/v1-3/operations/getsensordata.md): GET /sensorData
- [Generate a bearer token | Orion Data API v1.3](https://docs.oriondata.io/api/orion-data/v1-3/operations/gettoken.md): GET /token
- [List devices | Orion Data API v1.3](https://docs.oriondata.io/api/orion-data/v1-3/operations/getuserdevices.md): GET /userDevices
- [Get validated sensor data | Orion Data API v1.3](https://docs.oriondata.io/api/orion-data/v1-3/operations/getvalidatedsensordata.md): GET /validatedSensorData

## Orion Data API v1.2 (deprecated)

- [Overview | Orion Data API v1.2](https://docs.oriondata.io/api/orion-data/v1-2.md)
- [Get sensor data | Orion Data API v1.2](https://docs.oriondata.io/api/orion-data/v1-2/operations/getsensordata.md): GET /sensorData
- [Generate a bearer token | Orion Data API v1.2](https://docs.oriondata.io/api/orion-data/v1-2/operations/gettoken.md): GET /token
- [List devices | Orion Data API v1.2](https://docs.oriondata.io/api/orion-data/v1-2/operations/getuserdevices.md): GET /userDevices
- [Get validated sensor data | Orion Data API v1.2](https://docs.oriondata.io/api/orion-data/v1-2/operations/getvalidatedsensordata.md): GET /validatedSensorData

## Orion Data API v1.1 (deprecated)

- [Overview | Orion Data API v1.1](https://docs.oriondata.io/api/orion-data/v1-1.md)
- [Get sensor data | Orion Data API v1.1](https://docs.oriondata.io/api/orion-data/v1-1/operations/getsensordata.md): GET /sensorData
- [Generate a bearer token | Orion Data API v1.1](https://docs.oriondata.io/api/orion-data/v1-1/operations/gettoken.md): GET /token
- [List devices | Orion Data API v1.1](https://docs.oriondata.io/api/orion-data/v1-1/operations/getuserdevices.md): GET /userDevices

## Agent resources

- [orion-api skill](https://docs.oriondata.io/.well-known/agent-skills/orion-api/SKILL.md): Call or write code against the Orion Data API, the read-only HTTP API for listing a user's devices and extracting sensor readings. Covers API keys and bearer tokens, version pinning, pagination, rate limits, timestamps and error handling. Use the orion-docs skill for questions about using the Orion Data web portal.
- [orion-docs skill](https://docs.oriondata.io/.well-known/agent-skills/orion-docs/SKILL.md): Answer questions about the Orion Data web portal from its task Guides and feature Docs, including devices, channels, alarms, calibrations, dashboards and access. Use the orion-api skill for programmatic access through the Orion Data API.
- [Agent skills index](https://docs.oriondata.io/.well-known/agent-skills/index.json): Discovery index with SHA-256 digests.
- [Orion Data API v1.3 OpenAPI document](https://docs.oriondata.io/api/orion-data/v1-3/openapi.json)
- [Orion Data API v1.2 OpenAPI document](https://docs.oriondata.io/api/orion-data/v1-2/openapi.json) (deprecated)
- [Orion Data API v1.1 OpenAPI document](https://docs.oriondata.io/api/orion-data/v1-1/openapi.json) (deprecated)
- [Content index](https://docs.oriondata.io/content-index.json): Stable document IDs and metadata for every exported page.