---
title: "Sleep Score"
method: POST
path: "/api/v1/sleep/sleep-score"
tags: ["Sleep Wellness"]
---

# Sleep Score

`POST /api/v1/sleep/sleep-score`

## Request

- Base URL: `https://www.deepmapai.com`
- URL: `https://www.deepmapai.com/api/v1/sleep/sleep-score`
- Auth: none declared

Compute sleep quality score from metrics.

**Pricing:** Included in subscription tiers (legacy list price: GET /api/v1/billing/pricing).

## Query parameters

- `x_api_key` string, nullable

## Request body

- SleepScoreRequest
  - `total_sleep_time_min` number, required
  - `sleep_efficiency_pct` number
  - `deep_sleep_pct` number
  - `rem_sleep_pct` number
  - `awakening_count` integer
  - `sleep_onset_latency_min` number
  - `breathing_regularity` number

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/deepmapai/apis/deepmap-ai.md) · [All operations](https://skmtc.dev/deepmapai/apis/deepmap-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/deepmapai/apis/deepmap-ai/revisions/dab995d977d0?raw)