plexjava/docs/sdks/statistics

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

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.SDKError;
import dev.plexapi.sdk.models.operations.GetStatisticsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            PlexAPI sdk = PlexAPI.builder()
                .accessToken("<YOUR_API_KEY_HERE>")
                .xPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40")
                .build();

            GetStatisticsResponse res = sdk.statistics().getStatistics()
                .timespan(4L)
                .call();

            if (res.object().isPresent()) {
                // handle response
            }
        } catch (dev.plexapi.sdk.models.errors.GetStatisticsBadRequest e) {
            // handle exception
            throw e;
        } catch (dev.plexapi.sdk.models.errors.GetStatisticsUnauthorized e) {
            // handle exception
            throw e;
        } catch (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

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

Response

GetStatisticsResponse

Errors

Error Object	Status Code	Content Type
models/errors/GetStatisticsBadRequest	400	application/json
models/errors/GetStatisticsUnauthorized	401	application/json
models/errors/SDKError	4xx-5xx	*/*

getResourcesStatistics

This will return the resources for the server

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.SDKError;
import dev.plexapi.sdk.models.operations.GetResourcesStatisticsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            PlexAPI sdk = PlexAPI.builder()
                .accessToken("<YOUR_API_KEY_HERE>")
                .xPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40")
                .build();

            GetResourcesStatisticsResponse res = sdk.statistics().getResourcesStatistics()
                .timespan(4L)
                .call();

            if (res.object().isPresent()) {
                // handle response
            }
        } catch (dev.plexapi.sdk.models.errors.GetResourcesStatisticsBadRequest e) {
            // handle exception
            throw e;
        } catch (dev.plexapi.sdk.models.errors.GetResourcesStatisticsUnauthorized e) {
            // handle exception
            throw e;
        } catch (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

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

Response

GetResourcesStatisticsResponse

Errors

Error Object	Status Code	Content Type
models/errors/GetResourcesStatisticsBadRequest	400	application/json
models/errors/GetResourcesStatisticsUnauthorized	401	application/json
models/errors/SDKError	4xx-5xx	*/*

getBandwidthStatistics

This will return the bandwidth statistics for the server

Example Usage

package hello.world;

import dev.plexapi.sdk.PlexAPI;
import dev.plexapi.sdk.models.errors.SDKError;
import dev.plexapi.sdk.models.operations.GetBandwidthStatisticsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {
        try {
            PlexAPI sdk = PlexAPI.builder()
                .accessToken("<YOUR_API_KEY_HERE>")
                .xPlexClientIdentifier("gcgzw5rz2xovp84b4vha3a40")
                .build();

            GetBandwidthStatisticsResponse res = sdk.statistics().getBandwidthStatistics()
                .timespan(4L)
                .call();

            if (res.object().isPresent()) {
                // handle response
            }
        } catch (dev.plexapi.sdk.models.errors.GetBandwidthStatisticsBadRequest e) {
            // handle exception
            throw e;
        } catch (dev.plexapi.sdk.models.errors.GetBandwidthStatisticsUnauthorized e) {
            // handle exception
            throw e;
        } catch (SDKError e) {
            // handle exception
            throw e;
        } catch (Exception e) {
            // handle exception
            throw e;
        }

    }
}

Parameters

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

Response

GetBandwidthStatisticsResponse

Errors

Error Object	Status Code	Content Type
models/errors/GetBandwidthStatisticsBadRequest	400	application/json
models/errors/GetBandwidthStatisticsUnauthorized	401	application/json
models/errors/SDKError	4xx-5xx	*/*