plexcsharp/docs/sdks/statistics/README.md

Statistics

(Statistics)

Overview

API Calls that perform operations with Plex Media Server Statistics

Available Operations

• GetStatistics - Get Media Statistics
• GetResourcesStatistics - Get Resources Statistics
• GetBandwidthStatistics - Get Bandwidth Statistics

GetStatistics

This will return the media statistics for the server

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Requests;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(
    accessToken: "<YOUR_API_KEY_HERE>",
    clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
    clientName: "Plex for Roku",
    clientVersion: "2.4.1",
    platform: "Roku",
    deviceNickname: "Roku 3"
);

var res = await sdk.Statistics.GetStatisticsAsync(timespan: 4);

// handle response

Parameters

Parameter	Type	Required	Description	Example
Timespan	long	➖	The timespan to retrieve statistics for the exact meaning of this parameter is not known	4

Response

GetStatisticsResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetStatisticsBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetStatisticsUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetResourcesStatistics

This will return the resources for the server

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Requests;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(
    accessToken: "<YOUR_API_KEY_HERE>",
    clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
    clientName: "Plex for Roku",
    clientVersion: "2.4.1",
    platform: "Roku",
    deviceNickname: "Roku 3"
);

var res = await sdk.Statistics.GetResourcesStatisticsAsync(timespan: 4);

// handle response

Parameters

Parameter	Type	Required	Description	Example
Timespan	long	➖	The timespan to retrieve statistics for the exact meaning of this parameter is not known	4

Response

GetResourcesStatisticsResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetResourcesStatisticsBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetResourcesStatisticsUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*

GetBandwidthStatistics

This will return the bandwidth statistics for the server

Example Usage

using LukeHagar.PlexAPI.SDK;
using LukeHagar.PlexAPI.SDK.Models.Requests;
using LukeHagar.PlexAPI.SDK.Models.Components;

var sdk = new PlexAPI(
    accessToken: "<YOUR_API_KEY_HERE>",
    clientID: "3381b62b-9ab7-4e37-827b-203e9809eb58",
    clientName: "Plex for Roku",
    clientVersion: "2.4.1",
    platform: "Roku",
    deviceNickname: "Roku 3"
);

var res = await sdk.Statistics.GetBandwidthStatisticsAsync(timespan: 4);

// handle response

Parameters

Parameter	Type	Required	Description	Example
Timespan	long	➖	The timespan to retrieve statistics for the exact meaning of this parameter is not known	4

Response

GetBandwidthStatisticsResponse

Errors

Error Type	Status Code	Content Type
LukeHagar.PlexAPI.SDK.Models.Errors.GetBandwidthStatisticsBadRequest	400	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.GetBandwidthStatisticsUnauthorized	401	application/json
LukeHagar.PlexAPI.SDK.Models.Errors.SDKException	4XX, 5XX	*/*