Rippling: Trigger a report run — request body — body filters array item
Trigger a report run: request body, field body / filters / array / item. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: Trigger a report run — request body — body filters array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single filter to apply when running a report. The expected shape of ‘value’ depends on the operator — see the FilterOperator description for details. |
field_id | string | Required within parent | The ID of the report field to filter on |
operator | string | Required within parent | Comparison operator for the filter. Single-value operators (EQ, NE, GT, GTE, LT, LTE, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS, BEFORE, AFTER) require a scalar value. List operators (IN, NOT_IN) require a non-empty array. Range operators (BETWEEN, NOT_BETWEEN) require an object with ‘from’ and ‘to’ keys. No-value operators (IS_EMPTY, IS_NOT_EMPTY) do not require a value. Rolling-date operators (LAST_N, NEXT_N) require an object with ‘unit’ (DAY, WEEK, MONTH, YEAR) and ‘n’ (integer). Calendar-date operators (CURRENT_CALENDAR, PREVIOUS_CALENDAR) require a unit string (DAY, WEEK, MONTH, QUARTER, YEAR). One of: EQ, NE, IN, NOT_IN, STARTS_WITH, ENDS_WITH, CONTAINS, NOT_CONTAINS, GT, GTE, LT, LTE, BETWEEN, NOT_BETWEEN, IS_EMPTY, IS_NOT_EMPTY, BEFORE, AFTER, LAST_N, NEXT_N, CURRENT_CALENDAR, PREVIOUS_CALENDAR |
value | JSON | Optional | |
value (anyOf 1) | JSON | Alternative | The filter value. Shape depends on the operator: scalar for single-value operators; array for list operators; RangeValue object ({from, to}) for range operators; RollingDateValue object ({unit, n}) for rolling-date operators; unit string for calendar-date operators; omitted or null for IS_EMPTY/IS_NOT_EMPTY. |
value (anyOf 1) (oneOf 1) | string | Alternative | |
value (anyOf 1) (oneOf 2) | number | Alternative | |
value (anyOf 1) (oneOf 3) | boolean | Alternative | |
value (anyOf 1) (oneOf 4) | array | Alternative | |
value (anyOf 1) (oneOf 5) | Model | Alternative | Expand Trigger a report run — request body — body filters array item value value from, to |
value (anyOf 1) (oneOf 6) | Model | Alternative | Expand Trigger a report run — request body — body filters array item value value n, unit |
value (anyOf 2) | null | Alternative |
Referenced models: Trigger a report run — request body — body filters array item value value from, to, Trigger a report run — request body — body filters array item value value n, unit