Rippling: Trigger a report run — request body — body
Trigger a report run: request body, field body. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: Trigger a report run — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
filters | JSON | Optional | |
filters (anyOf 1) | array | Alternative | Optional list of filters to apply when running the report Default: null |
filters (anyOf 1)[] | Model | Each item | Expand Trigger a report run — request body — body filters array item |
filters (anyOf 2) | null | Alternative | |
format_currency_fields | JSON | Optional | |
format_currency_fields (anyOf 1) | JSON | Alternative | Formatting options for currency fields Default: null |
format_currency_fields (anyOf 1) (anyOf 1) | object | Alternative | |
format_currency_fields (anyOf 1) (anyOf 1).columns | string | Required within parent | Currency column format for currency fields One of: TYPE_AND_AMOUNT, VALUE_ONLY |
format_currency_fields (anyOf 1) (anyOf 1).currency_type | JSON | Optional | |
format_currency_fields (anyOf 1) (anyOf 1).currency_type (anyOf 1) | string | Alternative | Currency type (e.g., ‘USD’) |
format_currency_fields (anyOf 1) (anyOf 1).currency_type (anyOf 2) | null | Alternative | |
format_currency_fields (anyOf 1) (anyOf 2) | null | Alternative | |
format_currency_fields (anyOf 2) | null | Alternative | |
format_date_fields | JSON | Optional | |
format_date_fields (anyOf 1) | JSON | Alternative | Formatting options for date fields Default: null |
format_date_fields (anyOf 1) (anyOf 1) | object | Alternative | |
format_date_fields (anyOf 1) (anyOf 1).date_format | string | Required within parent | Date format for date fields in the report output One of: ISO_8601, APPLY_VISUALIZATION_SETTINGS |
format_date_fields (anyOf 1) (anyOf 1).datetime_timezone | JSON | Optional | |
format_date_fields (anyOf 1) (anyOf 1).datetime_timezone (anyOf 1) | string | Alternative | Timezone for datetime fields (e.g., ‘America/Los_Angeles’) |
format_date_fields (anyOf 1) (anyOf 1).datetime_timezone (anyOf 2) | null | Alternative | |
format_date_fields (anyOf 1) (anyOf 2) | null | Alternative | |
format_date_fields (anyOf 2) | null | Alternative | |
include_object_ids | boolean | Optional | Whether to include object IDs in the report output Default: false |
include_total_rows | boolean | Optional | Whether to include total row count in the report output Default: false |
output_type | string | Optional | Output format for the report data Default: JSON One of: JSON, CSV |
report_id | string | Required within parent | The ID of the report to run |
view_as | string | Optional | Controls whose permissions are used when running the report. VIEWER (default) uses the API token owner’s own permissions. OWNER uses the report owner’s permissions (requires owner-level access to the report). Default: VIEWER One of: VIEWER, OWNER |
Referenced models: Trigger a report run — request body — body filters array item