import { APIResource } from "../../core/resource.js"; import { BasePage, type BasePageParams, PagePromise } from "../../core/pagination.js"; import { RequestOptions } from "../../internal/request-options.js"; /** * Deprecated, please refer to the Dimensions APIs. */ export declare class Filters extends APIResource { /** * 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. * * @deprecated */ listValues(filterID: string, query?: FilterListValuesParams | null | undefined, options?: RequestOptions): PagePromise; } export type FilterValuesBasePage = BasePage; export interface FilterValue { total_count: number; value: string | null; } export interface FiltersResponse { data: FiltersResponse.Data; timeframe: Array; total_row_count: number | null; } export declare namespace FiltersResponse { interface Data { advanced: Array; basic: Array; } } export interface FilterListValuesParams extends BasePageParams { /** * Filter results using key:value pairs. Must be provided as an array query string * parameter. * * **Basic filtering:** * * - `filters[]=dimension:value` - Include rows where dimension equals value * - `filters[]=!dimension:value` - Exclude rows where dimension equals value * * **For trace dimensions (like video_cdn_trace):** * * - `filters[]=+dimension:value` - Include rows where trace contains value * - `filters[]=-dimension:value` - Exclude rows where trace contains value * - `filters[]=dimension:[value1,value2]` - Exact trace match * * **Examples:** * * - `filters[]=country:US` - US views only * - `filters[]=+video_cdn_trace:fastly` - Views using Fastly CDN */ filters?: Array; /** * 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` */ timeframe?: Array; } export declare namespace Filters { export { type FilterValue as FilterValue, type FiltersResponse as FiltersResponse, type FilterValuesBasePage as FilterValuesBasePage, type FilterListValuesParams as FilterListValuesParams, }; } //# sourceMappingURL=filters.d.ts.map