Skip to main content

RecurrenceDetectionGroup

A recurrence group produced by running detection over a set of transactions.

type RecurrenceDetectionGroup {
  avgAmount: Float!
  avgInterval: Float!
  categoryType: PreviewRecurrenceCategoryType!
  confidence: Float!
  eventIds: [String!]!
  forecastedDates: [Date!]
  id: String!
  interval: Float!
  length: Int!
  merchant: String!
  transactionIds: [ID!]!
  transactions: [RecurrenceDetectionTransaction!]!
}

Fields​

RecurrenceDetectionGroup.avgAmount ● Float! non-null scalar​

Average transaction amount across the group.

RecurrenceDetectionGroup.avgInterval ● Float! non-null scalar​

Average observed gap between occurrences, in days. -1 if unknown.

RecurrenceDetectionGroup.categoryType ● PreviewRecurrenceCategoryType! non-null enum​

Stream-level category group type for UI bucketing: expense, income, or transfer. Majority of in-range member categories, else derived from avgAmount sign.

RecurrenceDetectionGroup.confidence ● Float! non-null scalar​

Detection confidence in the range 0-1.

RecurrenceDetectionGroup.eventIds ● [String!]! non-null scalar​

External IDs of every occurrence in the group, including any outside the requested range.

RecurrenceDetectionGroup.forecastedDates ● [Date!] list scalar​

Cadence-projected occurrence dates in the in-range transaction window, starting one cycle after the earliest in-range charge. Used by the playground timeline. Null when the session predates this field (client may fall back to interval math). Empty when the cadence is unknown.

RecurrenceDetectionGroup.id ● String! non-null scalar​

RecurrenceDetectionGroup.interval ● Float! non-null scalar​

Nominal cadence of the group, in days (e.g. 30 for monthly). -1 if unknown.

RecurrenceDetectionGroup.length ● Int! non-null scalar​

Total number of occurrences (events) detected in the group.

RecurrenceDetectionGroup.merchant ● String! non-null scalar​

Merchant name the group was detected for.

RecurrenceDetectionGroup.transactionIds ● [ID!]! non-null scalar​

IDs of the group's transactions that fall within the requested range.

RecurrenceDetectionGroup.transactions ● [RecurrenceDetectionTransaction!]! non-null object​

The group's transactions that fall within the requested range.

Member Of​

PreviewRecurrenceDetectionSession object