Skip to content

Latest commit

 

History

History
78 lines (55 loc) · 2.81 KB

DataApi.md

File metadata and controls

78 lines (55 loc) · 2.81 KB
Raw

Api42Vb\Client\DataApi

All URIs are relative to https://api-sbx.42videobricks.com, except if the operation defines another base path.

Method HTTP request Description
getDataVideoUsage() GET /data/videos/usage List Video Usage KPIs

getDataVideoUsage()

getDataVideoUsage($limit, $offset, $interval, $start_date, $end_date): \Api42Vb\Client\Model\DataVideoUsageList

List Video Usage KPIs

Return the usage of the platform ressources. By default, it returns monthly usage but unit (dayly|week|month) can be defined. For current period, usage is calculated until current time. Start and end dates can be also optionaly defined to filter results.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: api_key
$config = Api42Vb\Client\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Api42Vb\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new Api42Vb\Client\Api\DataApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$limit = 56; // int | Number of elements to return (default=10)
$offset = 56; // int | offset for pagination
$interval = {{interval}}; // string | Period unit (day|week|month)
$start_date = {{starDate}}; // string | Start date for the period
$end_date = {{endDate}}; // string | End date for the period

try {
    $result = $apiInstance->getDataVideoUsage($limit, $offset, $interval, $start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDataVideoUsage: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
limit int Number of elements to return (default=10) [optional]
offset int offset for pagination [optional]
interval string Period unit (day week
start_date string Start date for the period [optional]
end_date string End date for the period [optional]

Return type

\Api42Vb\Client\Model\DataVideoUsageList

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]