# Apnealytics

> Guides and API reference for Apnealytics — see your CPAP therapy clearly.

- [Apnealytics documentation](https://help.apnealytics.com/index.md): Guides for using Apnealytics, plus the REST API reference for reading your therapy data programmatically.
- [Getting started](https://help.apnealytics.com/guides/quickstart.md): Create your account, import your first ResMed data card, and read your first night of therapy data in Apnealytics.
- [Importing data](https://help.apnealytics.com/guides/importing-data.md): How to pull your CPAP SD card and upload it to Apnealytics, what gets read, how long it takes, re-importing, supported hardware, and fixing common import problems.
- [Understanding AHI](https://help.apnealytics.com/guides/understanding-ahi.md): What the Apnea-Hypopnea Index measures, the GREAT / MILD / MODERATE / HIGH bands, the sub-indices behind the number, and why machine AHI is for tracking trends, not diagnosis.
- [Metrics explained](https://help.apnealytics.com/guides/metrics-explained.md): Usage and adherence, leak, pressure (P95 and EPR), event composition, oximetry (SpO2, ODI, T90), and per-night waveforms — what each metric in Apnealytics means and how to read it.
- [Accounts & privacy](https://help.apnealytics.com/guides/accounts-privacy.md): Signing in with a magic link or password, syncing Apple Health / Health Connect vitals, exporting your data, deleting your account, and how Apnealytics keeps your health data private.
- [Introduction](https://help.apnealytics.com/api-reference/introduction.md): A read-only REST API for your own Apnealytics therapy data, authenticated with a personal API key.
- [Account profile](https://help.apnealytics.com/api-reference/account/account-profile.md): Returns the caller's account name, their current machine (if set), and high-level counts for the nights on record. History visible to the key follows the account's plan (Pro: all nights).
- [Aggregate therapy summary](https://help.apnealytics.com/api-reference/therapy/aggregate-therapy-summary.md): Returns an aggregate summary computed across all nights on record: adherence, usage, usage-weighted AHI, event composition, and best/worst nights. Nights with under 1 minute of usage are excluded from the summary; `compliantNights` counts nights with at least 4 hours (240 minutes) of usage.
- [Nightly rows](https://help.apnealytics.com/api-reference/therapy/nightly-rows.md): Returns individual nightly rows in ascending date order. Optionally filter by an inclusive date window with `from` / `to`. The response contains the most recent `limit` rows that match the filter (default 100, maximum 1000); `total` is the number of rows matching the filter before the limit is appli…
- [Daily vitals](https://help.apnealytics.com/api-reference/vitals/daily-vitals.md): Returns wearable / Apple Health daily metrics, one row per night date, in ascending date order. Any metric not recorded for a given day is `null`.

## OpenAPI Specs

- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.