# Get Sleep Data — Google Health

> Get the user's sleep sessions with per-stage totals, time asleep and awake, and a derived efficiency figure. A session is attributed to the date the user woke up, matching Fitbit — asking for 2026-08-24 returns the night of the 23rd into…

- Key: `google_health-get-sleep-data`
- Type: Action (Read-only)
- Version: 0.0.2
- App: Google Health (`google_health`) — https://pipedream.com/apps/google-health.md
- This page (HTML): https://pipedream.com/apps/google-health/actions/get-sleep-data
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/google_health/actions/get-sleep-data/get-sleep-data.mjs

## Description

Get the user's sleep sessions with per-stage totals, time asleep and awake, and a derived efficiency figure. A session is attributed to the date the user **woke up**, matching Fitbit — asking for 2026-08-24 returns the night of the 23rd into the 24th. Example: startDate="2026-08-24" → `sessions: [{ startTime, endTime, type: "STAGES", isMainSleep: true, minutesAsleep: 431, minutesAwake: 48, efficiency: 0.9, stageTotals: { LIGHT: 240, DEEP: 71, REM: 120, AWAKE: 48 } }]`, plus `mainSleep` and `totalMinutesAsleep`. Three things to tell the user rather than invent: this API has **no sleep score**, so none is returned, and `efficiency` is computed here as time asleep over time in bed — not the figure Fitbit showed. Stage names depend on `type`, so read `stageTotals` rather than assuming a fixed set: `STAGES` sessions report LIGHT/DEEP/REM/AWAKE, older `CLASSIC` ones only ASLEEP/AWAKE/RESTLESS. Naps are separate sessions with `isNap: true`. At most 125 sessions per call; `truncated: true` means narrow the range. [See the documentation](https://developers.google.com/health/reference/rest/v4/users.dataTypes.dataPoints/list)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `startDate` | `string` | No | Start date in YYYY-MM-DD format (e.g. 2026-08-24), in the user's own timezone. Defaults to today in UTC, which can be a day off from the user's local date late at night — pass an explicit date when the exact day matters. |
| `endDate` | `string` | No | End date in YYYY-MM-DD format, inclusive. Defaults to Start Date, i.e. a single day. For a whole week, set Start Date to the Monday and End Date to the Sunday. |
| `fields` | `string[]` | No | Field names to keep on each session. Defaults to a compact set: startTime, endTime, type, isMainSleep, isNap, minutesAsleep, minutesAwake, minutesInSleepPeriod, minutesToFallAsleep, efficiency, stageTotals. Also available (excluded by default because they are verbose): stages (every individual stage segment), shortAwakenings, outOfBedSegments, stagesStatus, minutesAfterWakeUp, utcOffset. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "google_health",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "google_health-get-sleep-data",
  arguments: {
    startDate: "Start Date",
    endDate: "End Date",
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "google_health-get-sleep-data",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    google_health: { authProvisionId: "apn_xxxxxxx" },
    startDate: "Start Date",
    endDate: "End Date",
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "google_health-get-sleep-data",
    "configured_props": {
      "google_health": { "authProvisionId": "apn_xxxxxxx" },
      "startDate": "Start Date",
      "endDate": "End Date"
    }
  }'
```

---

- App: https://pipedream.com/apps/google-health.md · All apps: https://pipedream.com/apps