Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 3.29 KB

FiltersApi.md

File metadata and controls

74 lines (46 loc) · 3.29 KB

\FiltersApi

All URIs are relative to https://api.mux.com

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

ListFilterValuesResponse ListFilterValues(ctx, fILTERID, optional) 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.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
fILTERID string ID of the Filter
optional *ListFilterValuesOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ListFilterValuesOpts struct

Name Type Description Notes

limit | optional.Int32| Number of items to include in the response | [default to 25] page | optional.Int32| Offset by this many pages, of the size of `limit` | [default to 1] filters | optional.Interface of []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 | optional.Interface of []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` |

Return type

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

ListFiltersResponse ListFilters(ctx, ) List Filters

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

Required Parameters

This endpoint does not need any parameter.

Return type

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]