IRelativeDateFilter

Home > @gooddata/sdk-model > IRelativeDateFilter

IRelativeDateFilter type

Filters results to a relative date range.

Signature:

export type IRelativeDateFilter = {
    relativeDateFilter: IRelativeDateFilterBody;
} | {
    relativeDateFilter: IRelativeDateFilterAllTimeBody;
};

References: IRelativeDateFilterBody, IRelativeDateFilterAllTimeBody

Remarks

The relative filtering is always done on some granularity - this specifies the units in the 'from' and 'to' fields.

See DateAttributeGranularity, AllTimeGranularity and DateGranularity for further detail.