Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / ExportStatisticsParams

Interface: ExportStatisticsParams

Defined in: client/src/resources/exports/exports.types.ts:49

Parameters for the statistics export endpoint.

Supports token-based pagination via nextPageToken. Pass the token from the previous response to fetch the next page of results.

Extends ​

Properties ​

dateFrom ​

dateFrom: string

Defined in: client/src/resources/exports/exports.types.ts:14

Inherited from ​

ExportDateRange.dateFrom

dateTo ​

dateTo: string

Defined in: client/src/resources/exports/exports.types.ts:15

Inherited from ​

ExportDateRange.dateTo

decodeNames? ​

optional decodeNames?: boolean

Defined in: client/src/resources/exports/exports.types.ts:68

Automatically decode base64-encoded object.name for records where object.type === 'message'. Rule.io currently returns these names base64-encoded while every other object type returns plain text.

Default: true. A round-trip guard passes through values that do not cleanly re-encode as canonical base64, but it cannot distinguish between intentionally base64-encoded names and plain-text names that also happen to be valid base64.

Set to false to preserve raw API values exactly, including message names that look like base64 (for example when debugging or if upstream behavior changes).

nextPageToken? ​

optional nextPageToken?: string

Defined in: client/src/resources/exports/exports.types.ts:53

Pagination token from the previous response.

statisticTypes? ​

optional statisticTypes?: ExportStatisticFilterType[]

Defined in: client/src/resources/exports/exports.types.ts:51

Filter by statistic types.