mirror of
https://github.com/LukeHagar/plexgo.git
synced 2025-12-06 04:20:46 +00:00
2.8 KiB
2.8 KiB
Statistics
(Statistics)
Overview
API Calls that perform operations with Plex Media Server Statistics
Available Operations
- GetStatistics - Get Media Statistics
GetStatistics
This will return the media statistics for the server
Example Usage
package main
import(
"github.com/LukeHagar/plexgo/models/components"
"github.com/LukeHagar/plexgo"
"context"
"log"
)
func main() {
s := plexgo.New(
plexgo.WithSecurity("<YOUR_API_KEY_HERE>"),
plexgo.WithXPlexClientIdentifier("<value>"),
)
var timespan *int64 = plexgo.Int64(411769)
ctx := context.Background()
res, err := s.Statistics.GetStatistics(ctx, timespan)
if err != nil {
log.Fatal(err)
}
if res.Object != nil {
// handle response
}
}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ctx |
context.Context | ✔️ | The context to use for the request. |
timespan |
*int64 | ➖ | The timespan to retrieve statistics for the exact meaning of this parameter is not known |
Response
*operations.GetStatisticsResponse, error
| Error Object | Status Code | Content Type |
|---|---|---|
| sdkerrors.GetStatisticsResponseBody | 401 | application/json |
| sdkerrors.SDKError | 4xx-5xx | / |