> For the complete documentation index, see [llms.txt](https://docs.silk.us/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.silk.us/api-reference/endpoints/performance-statistics/volume-performance-stats.md).

# Volume performance stats

Performance statistics for individual volumes: IOPS, throughput, and latency.

Use this endpoint to find your busiest volumes, troubleshoot a slow application, or track a workload's performance over time. You can select volumes with any volume property, such as `name__in` or `volume_group.ref`, even though those properties aren't returned.

## Get volume performance stats

> Returns one or more data points starting from the requested time at the requested resolution. If there are no data points in the range, an empty set is returned. Throughput is in bytes.

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Volume performance stats","description":"Performance statistics for individual volumes: IOPS, throughput, and latency.\n\nUse this endpoint to find your busiest volumes, troubleshoot a slow application, or track a workload's performance over time. You can select volumes with any volume property, such as `name__in` or `volume_group.ref`, even though those properties aren't returned."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"parameters":{"datapoints":{"name":"__datapoints","in":"query","schema":{"type":"integer","default":1,"maximum":1000},"description":"Number of data points to return (limited to 1,000)."},"from_time":{"name":"__from_time","in":"query","schema":{"type":"integer"},"description":"Start time as a Unix timestamp (UTC). Defaults to now."},"resolution":{"name":"__resolution","in":"query","schema":{"type":"string","enum":["5s","5m","1h"],"default":"5s"},"description":"Time delta between data points."},"bs_breakdown":{"name":"__bs_breakdown","in":"query","schema":{"type":"boolean","default":false},"description":"Break down results by block size (one entry per each of the four block sizes)."},"rw_breakdown":{"name":"__rw_breakdown","in":"query","schema":{"type":"boolean","default":false},"description":"Break down results by reads and writes."},"pretty":{"name":"__pretty","in":"query","allowEmptyValue":true,"schema":{"type":"boolean"},"description":"Indent the response (responses are minified by default)."}},"schemas":{"Collection":{"type":"object","properties":{"hits":{"type":"array","items":{},"description":"The matching objects."},"limit":{"type":"integer","description":"Page size."},"offset":{"type":"integer","description":"Offset of the first returned object."},"total":{"type":"integer","description":"Total number of matching objects."}}},"StatsVolumes":{"type":"object","properties":{"iops_avg":{"type":"integer","description":"Average IOPS over the sample window."},"iops_max":{"type":"integer","description":"Peak IOPS observed in the sample window."},"latency_inner":{"type":"number","description":"Average inner latency, in milliseconds."},"latency_outer":{"type":"number","description":"Average outer latency, in milliseconds."},"resolution":{"type":"integer","description":"Sample resolution, in seconds."},"throughput_avg":{"type":"integer","description":"Average throughput, in bytes per second."},"throughput_max":{"type":"integer","description":"Peak throughput observed, in bytes per second."},"timestamp":{"type":"integer","description":"Unix timestamp of the sample."},"volume":{"$ref":"#/components/schemas/Ref","description":"Reference to the volume the sample describes. Shape: `{ \"ref\": \"/volumes/{id}\" }`."},"volume_name":{"type":"string","description":"Name of the volume."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/stats/volumes":{"get":{"tags":["Volume performance stats"],"summary":"Get volume performance stats","operationId":"listStatsVolumes","description":"Returns one or more data points starting from the requested time at the requested resolution. If there are no data points in the range, an empty set is returned. Throughput is in bytes.","parameters":[{"$ref":"#/components/parameters/datapoints"},{"$ref":"#/components/parameters/from_time"},{"$ref":"#/components/parameters/resolution"},{"$ref":"#/components/parameters/bs_breakdown"},{"$ref":"#/components/parameters/rw_breakdown"},{"$ref":"#/components/parameters/pretty"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Collection"},{"type":"object","properties":{"hits":{"type":"array","items":{"$ref":"#/components/schemas/StatsVolumes"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## GET /stats/volumes/{id}

> Get performance stats for a volume

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Volume performance stats","description":"Performance statistics for individual volumes: IOPS, throughput, and latency.\n\nUse this endpoint to find your busiest volumes, troubleshoot a slow application, or track a workload's performance over time. You can select volumes with any volume property, such as `name__in` or `volume_group.ref`, even though those properties aren't returned."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"schemas":{"Collection":{"type":"object","properties":{"hits":{"type":"array","items":{},"description":"The matching objects."},"limit":{"type":"integer","description":"Page size."},"offset":{"type":"integer","description":"Offset of the first returned object."},"total":{"type":"integer","description":"Total number of matching objects."}}},"StatsVolumes":{"type":"object","properties":{"iops_avg":{"type":"integer","description":"Average IOPS over the sample window."},"iops_max":{"type":"integer","description":"Peak IOPS observed in the sample window."},"latency_inner":{"type":"number","description":"Average inner latency, in milliseconds."},"latency_outer":{"type":"number","description":"Average outer latency, in milliseconds."},"resolution":{"type":"integer","description":"Sample resolution, in seconds."},"throughput_avg":{"type":"integer","description":"Average throughput, in bytes per second."},"throughput_max":{"type":"integer","description":"Peak throughput observed, in bytes per second."},"timestamp":{"type":"integer","description":"Unix timestamp of the sample."},"volume":{"$ref":"#/components/schemas/Ref","description":"Reference to the volume the sample describes. Shape: `{ \"ref\": \"/volumes/{id}\" }`."},"volume_name":{"type":"string","description":"Name of the volume."}}},"Ref":{"type":"object","description":"Reference to another object by its canonical URL.","properties":{"ref":{"type":"string"}},"required":["ref"]},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/stats/volumes/{id}":{"get":{"tags":["Volume performance stats"],"summary":"Get performance stats for a volume","operationId":"getStatsVolumes","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Collection"},{"type":"object","properties":{"hits":{"type":"array","items":{"$ref":"#/components/schemas/StatsVolumes"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.silk.us/api-reference/endpoints/performance-statistics/volume-performance-stats.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
