Rule.io SDK

Appearance

Rule.io SDK

Rule.io SDK / client/src / AnalyticsQueryParams

Interface: AnalyticsQueryParams

Defined in: client/src/resources/analytics/analytics.types.ts:63

Full analytics query params with object type, IDs, and metrics.

objectIds are strings (not numbers), matching the OpenAPI spec. When objectType is provided, both objectIds and metrics must be non-empty arrays.

Extends ​

Properties ​

dateFrom ​

dateFrom: string

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

Start date (inclusive), e.g. '2024-01-01'.

Inherited from ​

AnalyticsDateRangeParams.dateFrom

dateTo ​

dateTo: string

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

End date (inclusive), e.g. '2024-01-31'.

Inherited from ​

AnalyticsDateRangeParams.dateTo

messageType? ​

optional messageType?: AnalyticsMessageType

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

Optional filter by message type.

Inherited from ​

AnalyticsDateRangeParams.messageType

metrics ​

metrics: AnalyticsMetric[]

Defined in: client/src/resources/analytics/analytics.types.ts:69

Metrics to retrieve (at least one required).

objectIds ​

objectIds: string[]

Defined in: client/src/resources/analytics/analytics.types.ts:67

IDs of the objects to query (string array, not numbers).

objectType ​

objectType: AnalyticsObjectType

Defined in: client/src/resources/analytics/analytics.types.ts:65

The type of object to query analytics for.