---
title: "Get Volume Snapshot Details"
method: POST
path: "/telemetry/volumes/{volume_id}/snapshot_details"
tags: ["Ops IQ"]
---

# Get Volume Snapshot Details

`POST /telemetry/volumes/{volume_id}/snapshot_details`

## Request

- Base URL: `https://am1.portal.api.nasuni.com`
- URL: `https://am1.portal.api.nasuni.com/telemetry/volumes/{volume_id}/snapshot_details`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nasuni/apis/portal-api/docs/telemetry/volumes/:volume_id/snapshot_details/post.ts> (a function with typed inputs; its response is checked against the schema)

Get snapshot details telemetry for a volume.

## Path parameters

- `volume_id` string, required

## Request body

- VolumeTelemetryRequestDto: Request DTO for volume telemetry data (volume_id is in URL path).
  - `period` string, required: Time period in ISO 8601 format. Examples: 'PT1H' (last 1 hour), 'P1D' (last 1 day), '2025-01-01T00:00:00Z/2025-01-02T00:00:00Z' (specific interval), or millisecond timestamps '1730390400000/1730476800000'. Minimum range: 6 minutes.
  - `serial_numbers` string[], required: Appliance serial numbers to filter data - ensures stability across DR events
  - `chart_width` integer, nullable: Chart width in pixels (100-5200) - affects sampling density
  - `smart_sampling` boolean, nullable: Enable optimized dataset for trend analysis with faster load times

## Response `200`

Successful Response

- VolumeTelemetrySnapshotDetailsDto: List of volume snapshot details records
  - `metadata` object: Telemetry metadata (help text, metric definitions)
  - `items` VolumeTelemetrySnapshotDetailsRecord[], required: Raw snapshot metadata records with full details including P1/P2 phases
    - `appliance` string, required: Appliance name/description
    - `serial_number` string, required: Appliance serial number
    - `volume` string, required: Volume identifier
    - `time` integer, required: Timestamp in milliseconds when snapshot completed (same as metadata_snapshot_end)
    - `protect_mean` string, nullable: Average time in seconds for files to be protected during this snapshot
    - `protect_max` string, nullable: Max time in seconds any file took to be protected during this snapshot
    - `data_snapshot_start` integer, nullable: Timestamp in ms when P1 (data phase) started. Null=GFL-only snapshot
    - `data_snapshot_end` integer, nullable: Timestamp in ms when P1 (data phase) ended. Null=GFL-only snapshot
    - `metadata_snapshot_start` integer, required: Timestamp in ms when P2 (metadata phase) started
    - `metadata_snapshot_end` integer, required: Timestamp in ms when P2 (metadata phase) ended (snapshot completion)
    - `oud` integer, nullable: Oldest unprotected data age in seconds - time since oldest file was last protected
    - `file_count_ngl` integer, nullable: Count of non-GFL files in snapshot. Null=GFL-only snapshot
    - `file_count_gl` integer, nullable: Count of Global File Lock files in snapshot
    - `file_count_total` integer, nullable: Total count of all files in snapshot (NGL + GFL)
    - `dir_count` integer, required: Count of directories in snapshot
    - `volume_version` integer, required: Sequential snapshot version number for this volume

## Other responses

- `401`: Not authenticated
- `403`: Insufficient permissions or license
- `404`: Resource not found
- `408`: Request timeout
- `413`: Payload too large
- `422`: Invalid input data
- `429`: Too many requests (rate limit exceeded)
- `500`: Internal server error

---

[API](https://skmtc.dev/nasuni/apis/portal-api.md) - [All operations](https://skmtc.dev/nasuni/apis/portal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nasuni/apis/portal-api/revisions/2a505bec6d14?raw)