plexphp/docs/sdks/statistics/README.md

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

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \LukeHagar\Plex_API;
use \LukeHagar\Plex_API\Models\Components;
use \LukeHagar\Plex_API\Models\Operations;

$security = new Components\Security();
$security->accessToken = '<YOUR_API_KEY_HERE>';

$sdk = Plex_API\PlexAPI::builder()
    ->setXPlexClientIdentifier('Postman')
    ->setSecurity($security)->build();

try {
    

    $response = $sdk->statistics->getStatistics(4);

    if ($response->twoHundredApplicationJsonObject !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

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

Response

?\LukeHagar\Plex_API\Models\Operations\GetStatisticsResponse

getResourcesStatistics

This will return the resources for the server

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \LukeHagar\Plex_API;
use \LukeHagar\Plex_API\Models\Components;
use \LukeHagar\Plex_API\Models\Operations;

$security = new Components\Security();
$security->accessToken = '<YOUR_API_KEY_HERE>';

$sdk = Plex_API\PlexAPI::builder()
    ->setXPlexClientIdentifier('Postman')
    ->setSecurity($security)->build();

try {
    

    $response = $sdk->statistics->getResourcesStatistics(4);

    if ($response->twoHundredApplicationJsonObject !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

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

Response

?\LukeHagar\Plex_API\Models\Operations\GetResourcesStatisticsResponse

getBandwidthStatistics

This will return the bandwidth statistics for the server

Example Usage

<?php

declare(strict_types=1);

require 'vendor/autoload.php';

use \LukeHagar\Plex_API;
use \LukeHagar\Plex_API\Models\Components;
use \LukeHagar\Plex_API\Models\Operations;

$security = new Components\Security();
$security->accessToken = '<YOUR_API_KEY_HERE>';

$sdk = Plex_API\PlexAPI::builder()
    ->setXPlexClientIdentifier('Postman')
    ->setSecurity($security)->build();

try {
    

    $response = $sdk->statistics->getBandwidthStatistics(4);

    if ($response->twoHundredApplicationJsonObject !== null) {
        // handle response
    }
} catch (Throwable $e) {
    // handle exception
}

Parameters

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

Response

?\LukeHagar\Plex_API\Models\Operations\GetBandwidthStatisticsResponse