Mux v3.1.0 Mux.Data.Filters View Source

This module includes functions for retrieving available filters and their values in our system. These endpoints, for example, are used to construct the breakdown tables in the metrics UI. API Documentation

This module has been deprecated in favor of Data.Dimensions.

Link to this section Summary

Functions

Lists the values for a specific filter along with a total count of related views.

Lists all the filters broken out into basic and advanced.

Link to this section Functions

Link to this function

get(client, value, params \\ [])

View Source

Lists the values for a specific filter along with a total count of related views.

This method has been deprecated in favor of Data.Dimensions.get.

Returns {:ok, filters, raw_env}.

Examples

iex> client = Mux.client("my_token_id", "my_token_secret")
iex> {:ok, filters, _env} = Mux.Data.Filters.get(client, "browser")
iex> filters
[%{"total_count" => 2, "value" => "Safari"}, %{"total_count" => 1, "value" => "Chrome"}]

Lists all the filters broken out into basic and advanced.

This method has been deprecated in favor of Data.Dimensions.list.

Returns {:ok, filters, raw_env}.

Examples

iex> client = Mux.client("my_token_id", "my_token_secret")
iex> {:ok, filters, _env} = Mux.Data.Filters.list(client)
iex> filters
%{"advanced" => ["asn", "browser_version", "cdn", "experiment_name", "operating_system_version", "player_name", "player_version", "preroll_ad_asset_hostname", "preroll_ad_tag_hostname", "preroll_played", "preroll_requested", "sub_property_id", "video_series"], "basic" => ["browser", "country", "operating_system", "player_software", "player_software_version", "source_hostname", "source_type", "stream_type", "video_title"]}