Skip to content

Latest commit

 

History

History
138 lines (95 loc) · 5.46 KB

FiltersApi.md

File metadata and controls

138 lines (95 loc) · 5.46 KB

MuxPhp\FiltersApi

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

Method HTTP request Description
listFilterValues() GET /data/v1/filters/{FILTER_ID} Lists values for a specific filter
listFilters() GET /data/v1/filters List Filters

listFilterValues()

listFilterValues($filter_id, $limit, $page, $filters, $timeframe): \MuxPhp\Models\ListFilterValuesResponse

Lists values for a specific filter

The API has been replaced by the list-dimension-values API call. Lists the values for a filter along with a total count of related views.

Example

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


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\FiltersApi(
    // 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
);
$filter_id = abcd1234; // string | ID of the Filter
$limit = 25; // int | Number of items to include in the response
$page = 1; // int | Offset by this many pages, of the size of `limit`
$filters = array('filters_example'); // string[] | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.  To exclude rows that match a certain condition, prepend a `!` character to the dimension.  Possible filter names are the same as returned by the List Filters endpoint.  Example:    * `filters[]=operating_system:windows&filters[]=!country:US`
$timeframe = array('timeframe_example'); // string[] | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).  Accepted formats are...    * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600`   * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days`

try {
    $result = $apiInstance->listFilterValues($filter_id, $limit, $page, $filters, $timeframe);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FiltersApi->listFilterValues: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
filter_id string ID of the Filter
limit int Number of items to include in the response [optional] [default to 25]
page int Offset by this many pages, of the size of `limit` [optional] [default to 1]
filters string[] Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter. To exclude rows that match a certain condition, prepend a `!` character to the dimension. Possible filter names are the same as returned by the List Filters endpoint. Example: * `filters[]=operating_system:windows&filters[]=!country:US` [optional]
timeframe string[] Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). Accepted formats are... * array of epoch timestamps e.g. `timeframe[]=1498867200&timeframe[]=1498953600` * duration string e.g. `timeframe[]=24:hours or timeframe[]=7:days` [optional]

Return type

\MuxPhp\Models\ListFilterValuesResponse

Authorization

accessToken

HTTP request headers

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

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

listFilters()

listFilters(): \MuxPhp\Models\ListFiltersResponse

List Filters

The API has been replaced by the list-dimensions API call. Lists all the filters broken out into basic and advanced.

Example

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


// Configure HTTP basic authorization: accessToken
$config = MuxPhp\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new MuxPhp\Api\FiltersApi(
    // 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
);

try {
    $result = $apiInstance->listFilters();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FiltersApi->listFilters: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\MuxPhp\Models\ListFiltersResponse

Authorization

accessToken

HTTP request headers

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

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